Skip to content

Latest commit

 

History

History
24 lines (21 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

24 lines (21 loc) · 1.47 KB

Contributor guide

Pull requests

Pull requests are welcome!
Please include a clear description of the changes you have made with your request. The title should follow the conventional commits guideline with one of the following prefixes:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing tests or correcting existing tests
  • build: Changes that affect the build system or external dependencies
  • ci: Changes to our CI configuration files and scripts
  • chore: Other changes that don't modify src or test files
  • revert: Reverts a previous commit

All code should be covered by unit tests and comply with the coding guideline in this project.

Technical expectation
As a framework for supporting unit testing, this project has a high standard for testing itself.
In order to support this, static code analysis is performed using SonarCloud with quality gate requiring to

  • solve all issues reported by SonarCloud
  • have a code coverage of > 90%