Thank you for your interest in contributing to this project! We value and appreciate any contributions you can make.
Ways to contribute
-
Report a bug — open an issue in our issue tracker.
-
Suggest a feature — open an issue explaining your idea.
-
Contribute code — read the development guide and follow the step-by-step guide below.
Before you start
-
Before starting to contribute to the code, you must first sign the Contributor License Agreement (CLA) — see the CLA instructions.
Contribution guidelines
-
All contributors are expected to follow the project’s code of conduct. Please be respectful and considerate towards other contributors.
-
Before starting work on a new feature or fix, check existing issues and pull requests to avoid duplication.
-
If you wish to work on an existing issue, comment on it to let other contributors know you’re on it.
-
Discuss and gather feedback from the community before making significant changes to the project’s structure or architecture.
-
Keep a clean, organized commit history — divide changes into logical, descriptive commits.
-
Sign off your commits (
Signed-off-by) to comply with the DCO:-
use
git commit -s(orgit commit --signoff) on each commit, or -
enable it repository-wide:
git config commit.signoff true.
-
-
Document any new changes or features you add.
-
Link the corresponding issue in your pull request.
-
Add license and copyright information following the REUSE specification — this repository uses REUSE.toml to manage it.
How to contribute
-
Open an issue to discuss and gather feedback on the feature or fix you wish to address.
-
Fork the repository and clone it to your local machine — see GitHub Docs - Fork a repository.
-
Create a new branch to work on your contribution:
git checkout -b your-branch-name. -
Make the necessary changes in your local branch:
-
implement the new feature or fix;
-
follow the established project style and formatting guidelines;
-
test your changes to ensure they don’t introduce errors;
-
update documentation as needed — see the development guide.
-
-
Make clear, descriptive, signed-off commits that explain your changes.
-
Push your branch:
git push origin your-branch-name. -
Open a pull request describing your changes and linking the corresponding issue. Automated verification checks run on every pull request — unit, mutation, integration and Karate tests, each with its own coverage threshold.
-
Await review comments and make any necessary changes.
-
Once approved, your contribution is merged into the
developbranch and included in the next release.