Contributing a new feature !
Ajo George
Posted on October 4, 2024
Introduction
This week we had lab 04 in our open source course the main goal was to implement a new feature to a new classmate's Repo which we never used before. As the primary objective is about adding a feature to their too to read TOML configuration files and make use of that to pass values.
Contributing for Tailor4Job
This tool was developed by Inderpreet Singh Parmar, this is written on python the main goal of this tool is to give some seekers advice and recommendations based on their resume,cover letter and job description. Primary it is running on Gorq AI.
How did i implement this issue.
As TOML was a new idea for me i have used many resources online to learn about what is a TOML and how is that used in programs. Tailor4Job had its CLI arguments written on main.py
, so all of my contribution is only on that file.
-
Change 1
Installing TOML requirements viapip install TOML
and importing it into the programimport toml
As seen in the image, the first change was write a small function that will load in the toml config file from the root directory to the tool. This is a straightforward operation in which we use the function toml.load
to load the .toml
file to the tool. Finally it has stderr
and it will echo out error code if file is unable to load.
- Change 3
From this image, you can see that i am calling our previous function to load in the configuration file. The last step in this implementation was to tell the tool, to check the config file first if something is mentioned, use that or else use default values.
Pull Request
My Pull Request
I have send my PR to him and asked him to check via Slack as of now he hasn't responded yet if he does i will update this post
Conclusion
This lab was really interested helped me learn about the features and uses of TOML file, this lab also made me realise, how working with anther people can be challenging as in Open Source, the owner won't be available at all the time sto fix or review your PR. But overall this is a great experience and exposure to Open Source Development.
AJO GEORGE 04-10-2024
Posted on October 4, 2024
Join Our Newsletter. No Spam, Only the good stuff.
Sign up to receive the latest update from our blog.