Skip to content

Latest commit

 

History

History
56 lines (44 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

56 lines (44 loc) · 2.86 KB

How to contribute

We like to encourage you to contribute to the repository.

This should be as easy as possible for you but there are a few things to consider when contributing. The following guidelines for contribution should be followed if you want to submit a pull request.

How to prepare

  • You need a GitHub account
  • For bug reports or significant changes, submit an issue if one does not exist yet.
    • Describe the issue and include steps to reproduce if it's a bug.
    • Ensure to mention the earliest version that you know is affected.
    • For simple fixes like typos or minor documentation improvements, you can skip this step and submit a pull request directly.
  • If you are able and want to fix this, fork the repository on GitHub

Make Changes

  • In your forked repository, create a topic branch for your upcoming patch. (e.g. feature/new-backend or bug/auth-fails)
    • Usually this is based on the master branch.
    • Create a branch based on master git branch bug/auth-fails master then checkout the new branch with git checkout bug/auth-fails. Please avoid working directly on the master branch.
    • Note: GitHub's web editor may create automatic branch names like patch-1 if you edit files online, which is acceptable for quick fixes.
  • Make commits of logical units and describe them properly.
  • The coding style is checked by pre-commit.
  • For code contributions, make sure you stick to PEP8 coding style that is used already.
  • If the repository has tests, submit tests for your patch / new feature so it can be tested easily, and assure nothing is broken by running all the tests.
  • For notable changes, add a meaningful entry to the CHANGELOG.md document if it exists.

Submit Changes

  • Push your changes to a topic branch in your fork of the repository.
  • Open a pull request to the original repository and choose the right original branch you want to patch.
  • If not done in commit messages (which you really should do) please reference and update your issue with the code changes. But please do not close the issue yourself.
  • Even if you have write access to the repository, do not directly push or merge pull-requests. Let another team member review your pull request and approve.

Additional Resources

Notes

This documented is based in the work from anselmh/CONTRIBUTING.md, licensed as Creative Commons Attribution 3.0 Unported License.