Welcome! Thank you for showing interest in this repo! These are some rules that you must follow to contribute to this repo:
- Make sure you have installed the requirements. You can do so by running this command on the terminal :
pip install -r requirements.txt
- Note that to check your changes twice before PR.
- Comments and formatting are important, remember to use adequate spacing and use tabs for indentation.
- Fork the repository
- Clone your forked repository to your computer
- Head to the issues tab and look for an issue that you like. Issues marked "Good First Issue" or "Hacktoberfest" are great to start with!
- Once you have decided what issue to work on, give it a shot!
- Once done, push the code to your forked repository.
- Head to the Pull Requests tab and click on "Create New Pull Request"
- On the left of the arrow should be this repo and on the right should be yours.
- Add a small description to the Pull Request describing what you've done.
- Mention what Issue you have worked on. If the issue number is #3, you can mention "Closes #3" in the Pull Request description.
- Submit Pull Request.
Now that you are familiar with the process of contributing, get out there and get to solving some issues! Do not hesitate to contact the maintainers in case of any help required or problems encountered.