Skip to content

Latest commit

 

History

History
48 lines (29 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

48 lines (29 loc) · 1.44 KB

How to contribute

Welcome! Happy to see you willing to make the project better. Bug reports and pull requests from users are what keep this project working.

Development Environment

Pre commit hook

It is important to install pre-commit and pre commit hook to ensure all code run against black and flake8 before committing it and pushing to remote.

To install pre-commit, run below,

pip install pre-commit==2.2.0

After pre-commit installed in your system, please run below command to setup pre-commit hook.

pre-commit install

Now, your environment is ready and whenever you commit, pre-commit automatically trigger.

Basics

  1. Create an issue and describe your idea
  2. Fork it
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Commit your changes (git commit) with well-written commit message.
  5. Publish the branch (git push origin my-new-feature)
  6. Create a new Pull Request

Write documentation

Make sure to update the README.md and Wiki with the features added or changed once the PR is merged.

Finally

Thanks again for your interest in improving the project! You're taking action when most people decide to sit and watch.