Skip to content

Latest commit

 

History

History
45 lines (32 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

45 lines (32 loc) · 2.37 KB

How to contribute

Simple contribution guidelines to make open source happy and organized

Resist being a lazy developer, we can get through this together.

Project organization

  • Branch master is always stable and release-ready.
  • Branch dev is for development and merged into master when stable.
  • Feature branches should be created for adding new features and merged into dev when ready.
  • Bug fix branches should be created for fixing bugs and merged into dev when ready.

Opening a new issue

Do not open a duplicate issue!

  1. Look through existing issues to see if your issue already exists.
  2. If your issue already exists, comment on its thread with any information you have. Even if this is simply to note that you are having the same problem, it is still helpful!
  3. Always be as descriptive as you can.
  4. What is the expected behavior? What is the actual behavior? What are the steps to reproduce?
  5. Attach screenshots, videos, GIFs if possible.
  6. Include library version or branch experiencing the issue.

Submitting a pull request

  1. Find an issue to work on, or create a new one. Avoid duplicates, please check existing issues!
  2. Fork the repo, or make sure you are synced with the latest changes on dev.
  3. Create a new branch with a sweet name: git checkout -b issue_<##>_<description>.
  4. Make your feature/bug fix.
  5. Write unit tests when applicable.
  6. Keep your code nice and clean by adhering to the coding standards & guidelines below.
  7. Don't break unit tests or functionality. Run: python setup.py test
  8. Make sure your code does not reduce the current test coverage level.
  9. Update the documentation header comments if needed.
  10. Rebase on dev branch and resolve any conflicts before submitting a pull request!
  11. Submit a pull request to the dev branch.

You should submit one pull request per feature! The smaller the PR, the better your chances are of getting merged. Enormous PRs will likely take enormous amounts of time to review, or they will be rejected.

Style guidelines

Style and adherence to conventions is just as important as the code you write. Most of our time is spent reading code, not writing it. Don't be sloppy.

Above all, conform to the existing style of the code in which you are working. When in doubt, refer to PEP8.