This page explains the process of implementing new features or fixing bugs in the Karate Tools ecosystem, and points you at the repository structure and the step-by-step guide. For the contribution process itself (issues, pull requests), see Contributing.
Development process
The steps to follow are:
-
Implement the new feature or fix the bug.
-
Perform the necessary tests:
-
create or update the corresponding unit tests, execute them, and verify that they pass and that the code coverage is over the established threshold (90%);
-
execute the mutation tests, verify that they pass and that the mutation coverage is over the established threshold (90%);
-
create or update the corresponding integration tests, execute them, and verify that they pass and that the code coverage is over the established threshold (80%);
-
create or update the corresponding Karate tests, execute them, and verify that they pass and that the code coverage is over the established threshold (80%).
-
-
Update the relevant documentation.
The repository structure page describes the code structure, to help you find the location of the code to add or modify, how to execute and verify the tests, and how to update the documentation.
Environment setup
See Prerequisites for the tools and versions required, and the docs module for how to build this documentation site locally.
Testing
See each repository module's
own page for its testing instructions — unit and mutation tests for the
code modules, integration tests in karatetools-oss-boot, and Karate
tests in karatetools-oss-karate-test.
Once you’re ready, follow the step-by-step guide to submit your contribution.