Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

55 lines (38 loc) · 1.42 KB
Raw

Contributing

If you want to participate in this project, please follow this guidline.

Fork and clone this repository:

git clone [email protected]: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:

flake8 --install-hook git

# with make
make lint

Create a pull request

  1. Choose the develop branch as a target for new/changed functionality, master should only be targeted for urgent bugfixes.
  2. While it's not strictly required, it's highly recommended to create a new branch on your fork for each pull request.
  3. Push to your fork and submit a pull request.
  4. 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: