Issues and Pull Requests are welcome. Please follow the issue templates that are already configured. Have in mind the "Why" section (simplicity, OO code with good practices) which explain the vision of this tool.
There are different issue types according to the thing you want to report. Please adjust to that format unless you have a strong reason not to. If submitting bugs, it would be awesome if you include a minimal example demonstrating the problem, like a small test or suite.
- Base branch:
main. Please open PRs againstmain. - Not mandatory, but nice to have, use Gitmoji for tagging the type of commits you're adding.
If you add a new feature, please add:
- unit tests for it on the
tests/corefolder - an entry in the README explaining how to use it
- JSDoc on the public API classes and methods (ideally with examples on how to use them)
If you fix a bug, please add:
- unit tests for it on the
tests/corefolder
If you add a utility function, please put it in the Utils module. That way we control the complexity
of utils in just one module, and we maximize reuse across different parts of the tool.
If you are adding translations, you just need to change the translations.json file and your new language
and keys will be automatically supported.
Github Actions runs the CI builds. There are four steps on every build:
- npm build and install in every supported Node version
- lint check via
eslint - unit tests
- analyzing test coverage and code quality and send reports (Codeclimate and Sonarcloud)
There's also a build that runs only on the main branch that will calculate the mutation score and report it to the Stryker Dashboard.
This project uses Architectural Decision Records (ADR). The doc/decisions folder
contains the decisions taken so far. Please make sure the change you are sending is in line with those decisions.