14 lines (11 loc) · 655 Bytes

Contributing

for general questions, open a GitHub issue
in case of bugs, open issues with code example as reproducer

To propose a patch, fork the repository and use the following commands:

sbt test to run the test suite
sbt "docs/mdoc" "docs/laikaSite" to build the documentation locally (output in cornichon-docs/target/docs/site)

A PR should ideally include:

a clear description of the problem solved and of the solution implemented
unit tests
tests example of usage if the PR introduces changes in the DSL (e.g. SuperHeroesScenario)
an update to the documentation if necessary