Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (24 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

38 lines (24 loc) · 1.37 KB

Contribution guidelines

We welcome contributions from the open source community. If you want to contribute, we ask you to follow these guidelines. Please reach out to us if you have questions or wish to contribute.

Code of conduct

Please follow our Code of Conduct when contributing.

Coding conventions

We use the following code and API conventions:

License

The license information for this project can be found in LICENSE.md.

Conventional Commits

We use Conventional Commits for our commit messages. Specifically we use the following format for our commit messages:

<type>[optional scope]: <description>

[body]

[footer]

When you create a Pull Request (PR) please follow the following instructions to comply to our Conventional Commits guidelines:

  1. Make sure the PR title complies to: <type>[optional scope]: <description>. E.g. feat: add new feature.
  2. In the PR body fill in the body consisting of one line of text. E.g. Added new exciting feature.
  3. In the footer reference the JIRA issue (typically a subtask) number from our JIRA project as follows: Solves XXX, where XXX is the reference to the (JIRA) issue number.