Skip to content

Latest commit

 

History

History
32 lines (19 loc) · 1.28 KB

contributing.md

File metadata and controls

32 lines (19 loc) · 1.28 KB

Contributing

Contributing to this project is very much easy.

To contibute, open an issue describing the code you want to add to the repository then, wait to be assigned (Less than a day).

Then create a folder in the src folder with your github username. Inside this folder, create another folder with the name of the issue you want to solve.

Additionally, make sure to add a README describing your project and it's dependencies. See a README example

Also, add a requirements.txt file to make installation easier

Feel free to give the project a star.

Example

If I want to add a python script for basic addition I would create an issue stating so after assignment, I would create src/theadeyemiolayinka/addition/main.py, src/theadeyemiolayinka/addition/README.md and src/theadeyemiolayinka/addition/requirements.txt

Where theadeyemiolayinka is my username and addition is my project name.

PRs and Commits

Make sure to follow the covetional github commits . In this case, all your commits should be of type feat

NB: Issues and PRs are closed after three days of inactivity.

Happy Pythoning.

Cheers!