Skip to content
This repository has been archived by the owner on Mar 17, 2022. It is now read-only.

Latest commit

 

History

History
31 lines (22 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

31 lines (22 loc) · 1.25 KB

Thanks for contributing—you rock!

Getting Started

  • Make sure you have a GitHub account.

  • See if your issue has been discussed (or even fixed) earlier. You can search for existing issues.

  • Assuming it does not already exist, create a new issue.

    • Clearly describe the issue. In case you want to report a bug, include steps to reproduce it.
  • Fork the repository on GitHub.

Making Changes

  • Create a topic branch from where you want to base your work.
    • This is usually the master branch.
    • Only target release branches if you are certain your fix must be on that branch.
    • To quickly create a topic branch based on the master branch:
      • git checkout -b issue/%YOUR-ISSUE-NUMBER%_%DESCRIPTIVE-TITLE% master
      • a good example is issue/123_typo_in_readme
  • Make commits of logical units.
  • Make sure your commit messages are helpful.

Submitting Changes

  • Push your changes to the according topic branch in your fork of the repository.
  • Create a pull request to the original repository.
  • Wait for feedback. Pull requests get reviewed on a regular basis.

License

By contributing code, you grant its use under the MIT.