Skip to content

Pull Requests ​

Bug fixes ​

If you found a bug and wrote a fix for it, just create a pull request.

New features ​

For smaller enhancements, just create a pull request.

If you plan to implement any bigger new features, please create a new issue first so we can discuss if and how this feature can be implemented. If you want to work on implementing a feature from an existing issue, please leave a note there to avoid duplicate work.

Contribution guidelines ​

Git ​

In order to keep your pull request clean and reviewable, please follow these guidelines:

  • Create a new branch with a distinct name. Don't work on the main branch of your fork.
  • Keep each pull request focused on a single change.
  • Try to keep the pull request short. As a rule of thumb, a pull request should not be longer than 200-400 lines of code. If it is longer, consider splitting it into multiple pull requests.
  • Do not merge main into your PR branch. Instead, rebase it on main to keep the diff clean.

License ​

By submitting a contribution to this project, you agree that:

  • You retain ownership. You keep the copyright and all other rights to your work. You are free to use, modify, or license it elsewhere as you see fit.
  • You license your contribution under GPL-3.0-or-later. Your contribution is provided under the same GPL-3.0-or-later license as this project, and you grant the project a worldwide, perpetual, irrevocable, and royalty-free right to use, reproduce, modify, and distribute it under GPL-3.0-or-later.
  • You confirm you are authorized to contribute. You warrant that you are the rightful author of the code or have the necessary permission to share it.
  • You disclose third-party material. You will inform the maintainers in the pull request if your contribution includes any third-party material that requires special attribution or licensing.