Commit Conventions for main #23

Gregor-Gottschewski · 2025-06-16T18:37:01Z

Gregor-Gottschewski
Jun 16, 2025
Maintainer

Do we want to use a commit convention for commits on main and merges into main?
I suggest angular's commit conventions (I changed a few things for our needs):

Here's a sneak preview:

<type>(<scope>): <subject>
<BLANK LINE>
<body>

Type
Must be one of the following:

build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
docs: Documentation only changes
feat: A new feature
fix: A bug fix
perf: A code change that improves performance
refactor: A code change that neither fixes a bug nor adds a feature
style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
test: Adding missing tests or correcting existing tests

The Scope could be frontend, backend, core, db, etc.

Subject
The subject contains a succinct description of the change:

use the imperative, present tense: "change" not "changed" nor "changes"
don't capitalize the first letter
no dot (.) at the end

Body
Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.

These conventions are only important for the main branch! Use commit messages for other branches as you want.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Commit Conventions for main #23

Uh oh!

{{title}}

Uh oh!

Replies: 0 comments

Select a reply

Uh oh!

Commit Conventions for main #23

Uh oh!

Gregor-Gottschewski Jun 16, 2025 Maintainer

Replies: 0 comments

Gregor-Gottschewski
Jun 16, 2025
Maintainer