Contribution Guide

We appreciate all the help that we can get to improve this project. In this section, you will find useful information on how you can contribute.

Bug Report

If you have encountered a bug, feel free to report it. When reporting the bug, please consider the following:

  • Where is the defect located?
  • A good, short and precise description of the defect (Why is it a defect?)
  • How can the defect be replicated?
  • (A possible solution for how to resolve the defect)

Once we have received the bug or defect report, we will address it as reasonably as we can.

Security Vulnerability

See the Security Policy for details.

Feature Request

If you have an idea for a new feature or perhaps changing an existing one, please feel free to create a feature request.

Pull Requests

If you are able to fix a bug or defect, or perhaps add new features, then you can send us a pull request. Please follow this guideline:

  • Fork this project
  • Create a new local branch for the given fix, addition or change
  • Write your changes
  • Create executable test-cases (prove that your changes are solid!)
  • Commit and push your changes to your fork
  • Send a pull-request with your changes (please ensure to check “Allow edits from maintainers”)

We will review your pull request, as soon as time permits. If your changes are accepted, then they will be merged into this project and released in an upcoming version. Should your pull request not be accepted, then you will be informed about it.