Skip to content

Latest commit

 

History

History
29 lines (17 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

29 lines (17 loc) · 1.41 KB

How to contribute

Did you find an issue or bug?

  • Ensure the issue or bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible.

Contributor License Agreement

To get started, sign the Contributor License Agreement.

Making changes

Make a fork of the repository or create a topic branch to start your work.

  • Start the work from the current master branch using a topic branch.
  • To quickly create a topic branch based on master use git checkout -b fix/master/my_contribution master. Please avoid working directly on the master branch.

Submitting changes

If you have improvements, open a pull request! A getting started is available at Github.

Your pull request should include the following points:

  • Include a description of what your change intends to do.
  • Be a child commit of a reasonably recent commit in the master branch.
  • Have a clear commit message.
  • Include a reference to an issue if it relates to one, see link.