If the badges above didn't tell you yet, we are welcome to contributions from anyone and everyone!! If you want to add an extra feature, report/fix a bug, add an easter egg, write documentation or practically anything which popped up in your mind, feel free to reach out to us to discuss incorporating it in this repo
Even though we appreciate all types of contributions, it is important to follow the guidelines mentioned below for consistent code quality
- For? Anything you think would be relevant to us. This includes any bug you found, a feature you would wish to see etc.
- How? We use Github Issues to keep track of tasks and ideas. Feel free to open an issue there
- What all is required? Please be as comprehensive as possible in your descriptions. For bugs, please ensure they have the following
- Your system information, including but not limited to Python version and versions of the packages installed
- A small summary
- Steps to reproduce
- Expected behaviour
- Current behaviour
- Anything else - includes but not limited to what you think might be wrong, your notes about the issue etc.
- Would you like to work on it? Yes/No
- We use Tabs of width 4 throughout the code and expect you to follow the same for your contributions
- Please ensure that you run your code through black (we use the default configuration) to ensure consistency in coding conventions
All your code contributions will be used according to the GNU general public license, which you can find here
More than anything else, don't forget to enjoy coding! Cheers!!