Skip to content

Latest commit

 

History

History
83 lines (52 loc) · 3.35 KB

CONTRIBUTING.md

File metadata and controls

83 lines (52 loc) · 3.35 KB

Contribution Guidelines

This file contains all relevant information about contributing to this repository. Please read it carefully before contributing.

Tooling

We are using the following tools. These are only recommendations and not mandatory.

Tip

If you don't want to setup your own environment, you can use the provided DevContainer.

DevContainer

If you want to use Visual Studio Code, all of our tooling, preinstalled extensions and configured settings you can use the provided DevContainer.

To use the DevContainer you need to install the Remote - Containers extension.

Branches

This repository has two "relevant" branches: main and dev.

Every pull-request that implements a feature, fix or other changes must be created from the dev branch. The target branch of the pull request must also be the dev branch.

Branch Naming

Every branch should follow the following pattern:

  • feat/* for new features
  • fix/* for bug fixes

and so on. You can find more information about the possible types in the Commits section.

Every branch should only target one issue or feature.

Commits

We are using Conventional Commits for our commits. Every commit must follow this pattern.

The commit message is split into different parts:

  • Commit type. (e.g. feat, fix, chore, ci, test, ...)
  • Changed module/component in brackets. If you want to target a sub module/component you can add it after the module/component and separate it with a slash /. Example: (devcontainer) or (tests/e2e). If no module/component fits, you can leave this part out completely. Please don't use * as module/component or add empty brackets ().
  • A colon : to separate the type and module/component from the commit message.
  • Commit message. All messages must be in english and follow the conventions of the conventional commits standard. They must be written in the imperative, present tense. Example: "change" not "changed" nor "changes". The first letter should not be capitalized.

The resulting commit message should look like this:

  • feat(devcontainer): add documentation
  • fix: remove typo

Pull Requests

If you have completed your development on a branch, you have to create a pull request. The pull request must be pointed against the dev branch (see Branches).

The pull request title should be in the same pattern as the commit messages (see Commits), because the pull request title is used as the merge commit message.

Please update the labels of the PR accordingly.

After submitting the pull request, it will be reviewed and if everything is fine, it will be merged into the dev branch.

Every change to the dev branch will be merged to the main branch later on.

Releases

We are using Semantic Versioning for our releases.

Releases are created from the main branch.