Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

45 lines (31 loc) · 2.05 KB

Contribution Guidelines

We are looking forward to your contributions. Please take a moment to read these Contribution Guidelines.

Submitting Pull Requests

In case you want to submit a small fix, feel free to create a Pull Request. If you plan bigger changes, prefer to create an issue first to discuss the details. Make sure that your changes can be build and run on Linux, Mac and Windows. Your changes should also contain tests. Make sure that the coverage of new code is above 80%. Avoid breaking changes!

Some checks are unavailable for external Pull Requests from forks.

Maintainers have to run these checks manually.

Code Formatting

This project adhere to the Google Java Style Guide. You can use ./gradlew spotlessApply to format your code according to the style guide.

Changelog and Versioning

This project adheres to Semantic Versioning. Make sure that your commit messages follows the Semantic Commits conventions. Some examples for semantic commits:

  • feat: validate user is in database before creating a secret - for new features, creates a new minor release.
  • fix: avoid concurrency issues - for fixes to existing features, creates a new patch release.
  • test(documentdb): verify specific DocumentDB features - for new or modified tests regarding documentdb, no release is created.
  • docs: add a CONTRIBUTING.md - for changes that only modify documentation, no release is created.
  • chore: improve build speed - for changes to everything else, no release is created.

Our changelog is maintained in the GitHub releases.

PR Tags

PR Tags are unavailable for Pull Requests from forks!

Each PR creates a tag that can temporarily be included in deployments for testing. The generated tag uses the format: PR-<pr_number>. PR tags are cleaned up regularly from the repository so never use these in stable deployments.