Skip to content

Latest commit

 

History

History
19 lines (14 loc) · 907 Bytes

CONTRIBUTING.md

File metadata and controls

19 lines (14 loc) · 907 Bytes

Contribution Guideline

First of all: I am thankful for any contribution this project gets.

Creating Issues

You found a bug, you miss some feature in the project or have an idea how to improve the code? Then create a GitHub issue.

Creating Pull-Requests

  • Use a branch other than master.
  • Feel free to add yourself to the AUTHORS file. (optional)
  • Use clang-format to format the code.
  • Write in your commit messages what/why you did something. Often times a one-liner might be enough.
  • Explain for what your PR is for - like providing a use-case or something similar.
  • Update documentation of the Markdown syntax if anything changed there. (docs/definitions.md)
  • Add a changelog entry at "Upcoming" inside of CHANGELOG.md
  • Make sure that the tests are successful and if you wrote a bugfix, to have a test that highlights the issue.