If you want to participate in this project, please follow this guidline.
Fork and clone this repository:
git clone git@github.com:your-username/sruthi.git
Install the dependencies using pip
:
pip install -r requirements.txt
pip install -r test-requirements.txt
# or use make
make deps
Make sure the tests pass:
make test
To ensure a good quality of the code use flake8
to check the code style.
make lint
Note that this repository uses the black
code style, the reformat the code use:
make format
- Choose the
develop
branch as a target for new/changed functionality,master
should only be targeted for urgent bugfixes. - While it's not strictly required, it's highly recommended to create a new branch on your fork for each pull request.
- Push to your fork and submit a pull request.
- Check if the build ran successfully and try to improve your code if not.
At this point you're waiting for my review. I might suggest some changes or improvements or alternatives.
Some things that will increase the chance that your pull request is accepted:
- Write tests.
- Follow the Python style guide (PEP-8).
- Write a good commit message.