Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
Contributions to this project are released to the public under the project's open source license.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
- Fork and clone the repository
- Configure and install the dependencies:
pip3 install -r requirements.txt - Create a new branch:
git checkout -b my-branch-name - Push to your fork and submit a pull request
- Pat your self on the back and wait for your pull request to be reviewed! 🎉
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Follow the style guide - it'll automatically run via the super-linter.
- Write tests.
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
- Write a good commit message.