InditexTech Karate Tools

Contributing

How to contribute to Karate Tools.

Thank you for your interest in contributing to this project! We value and appreciate any contributions you can make.

Ways to contribute

Before you start

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 (or git 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

  1. Open an issue to discuss and gather feedback on the feature or fix you wish to address.

  2. Fork the repository and clone it to your local machine — see GitHub Docs - Fork a repository.

  3. Create a new branch to work on your contribution: git checkout -b your-branch-name.

  4. 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.

  5. Make clear, descriptive, signed-off commits that explain your changes.

  6. Push your branch: git push origin your-branch-name.

  7. 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.

  8. Await review comments and make any necessary changes.

  9. Once approved, your contribution is merged into the develop branch and included in the next release.