Skip to content

Latest commit

 

History

History
40 lines (30 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

40 lines (30 loc) · 2 KB
Raw

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
  • Submit an issue ticket for your issue if there is not one yet.
    • Describe the issue and include steps to reproduce when it's a bug.
    • Ensure to mention the earliest version that you know is affected.
    • If you plan on submitting a bug report, please submit pertinent information and logs along with the report using gist or some other paste service.
  • Fork the repository on GitHub

Make Changes

  • In your forked repository, create a topic branch for your upcoming patch.
    • Usually this is based on the main branch.
    • Create a branch based on main; git branch fix/main/my_contribution main then checkout the new branch with git checkout fix/main/my_contribution. Please avoid working directly on the main branch.
  • Make commits of logical units and describe them properly.
  • Check for unnecessary whitespace with git diff --check before committing.

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.
  • 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