Skip to content

Latest commit

 

History

History
33 lines (23 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

33 lines (23 loc) · 1.33 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via an issue.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Please mention the issue in your PR description.
  3. Expect to be taken seriously, if there is some feedbacks, feel free to discuss about it, your opinion can be better than mine.

Coding standards

A library is easier to use, and easier for contributors to work on, if it has a consistent, unified style, approach, and layout.

Tests

Currently the library has a 100% coverage, we should try to keep this at the same level.

Sonar

Sonarcloud is used in the project, it will comment your PR to give you feedback on your code.

Continuous integration

We have a list of steps on each PR. The CI is running:

  • Tests
  • Coverage
  • Code quality

With this CI you will have feedbacks on your PR after opening your PR. Please review it if it fails.

Performance

If you are doing something that can impact the performance, please add a new performance test.
You can see the evolution of the performance on this page: https://thomaspoignant.github.io/scim-patch/dev/bench/index.html