Read me first

Please read the project's overall CONTRIBUTING.md first.

How to contribute?

When providing contributes to this project, please adhere to the standards and conventions described further down in this document. Doing so please feel free to create merge requests.

Standards and conventions

Branching

We use Github flow.

Verified commits

We only allow verified commits:

Approval

MRs require one approval from the SouvAP devops team with security clearance.

Conventional Commits

See https://www.conventionalcommits.org/en/v1.0.0/#summary for reference.

Commits that do not adhere to the standard might be rejected.

<type>(<scope>): [path/to/issue#1] <short summary>
  │       │              │                │
  │       │              |                └─> Summary in present tense, sentence case, with no period at the end
  │       │              |
  │       │              └─> Issue reference (optional)
  │       │
  │       └─> Commit Scope: helmfile, docs, collabora, intercom-service, ...
  │
  └─> Commit Type: chore, ci, docs, feat, fix

Valid commit scopes:

helmfile
ci
docs
collabora
ìntercom-service
jitsi
keycloak
keycloak-bootstrap
nextcloud
open-xchange
openproject
provisioning
services
univention-corporate-container
xwiki

Semantic Release

See https://github.com/semantic-release/semantic-release for reference.

Linting

Following linters must pass:

Helm vs. Operators vs. Manifests

Due to DVS requirements:

we have to use Helm charts (that can consist of Manifests).
we should avoid stand alone Manifests.
we do not use Operators and CRDs.

In order to align the Helm files from various sources into an unified deployment of the SWP we make use of Helmfile.

Tooling

We should not introduce a new tool without sharing the purpose with the team and let the team decide if the tool should be used.

We should avoid adding unnecessary complexity.

2.7 KiB Raw Blame History