trinitrix/docs/CommitMessageStyle.md

<!--
Copyright (C) 2024 - 2024:
The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
SPDX-License-Identifier: GPL-3.0-or-later

This file is part of Trinitrix.

Trinitrix is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
by the Free Software Foundation, either version 3 of the License,
or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.
-->

# Commit message style

*This specification is heavily inspired by the [AngularJS commit message format](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format).*

We have very precise rules over how our Git commit messages must be formatted.
This format leads to **easier to read commit history**.

Each commit message consists of a **header**, a **body** (optional), and a **footer** (optional).

```
<header>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
```

The `header` is mandatory and must conform to the _Commit Message Header format_ (described below).

The `body` is mandatory for all commits that are not 100% self explainatory.
When the body is present it must be at least 20 characters long and must conform to the _Commit Message Body format_.

The `footer` is optional. The _Commit Message Footer format_ (described below) describes what the footer is used for and the structure it must have.

## Commit Message Header

```
<type>(<scope>): <short summary>
  │       │             │
  │       │             └─⫸ Summary in present tense. Not capitalized. No period at the end.
  │       │
  │       └─⫸ Commit Scope: The name of the affected module.
  │
  └─⫸ Commit Type: Build|Docs|Feat|Fix|Perf|Refactor|Test|Merge
```

The `<type>` and `<summary>` fields are mandatory, the `(<scope>)` field is optional.

### 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
- **Test**: Adding missing tests or correcting existing tests
- **Merge**: A merging commit

### Scope

The scope should be the name of the module affected (as perceived by the person reading the changelog generated from commit messages).

Specify submodules if needed!

Example scopes:

- `app::events`
- `ui`

When a commit affects the whole tree, use `treewide`.

### Summary

Use the summary field to provide 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

## Commit Message Body

Just as in the summary, use the imperative, present tense: "fix" not "fixed" nor "fixes".

Explain the motivation for the change in the commit message body. This commit message should explain _why_ you are making the change.
You can include a comparison of the previous behavior with the new behavior in order to illustrate the impact of the change.

This is not needed, if the summary is 100% self-explainatory.

## Commit Message Footer

The footer can contain information about breaking changes and deprecations and is also the place to reference issues and other PRs that this commit closes or is related to.
For example:

```
BREAKING CHANGE: <breaking change summary>
<BLANK LINE>
<breaking change description + migration instructions>
<BLANK LINE>
<BLANK LINE>
Fixes #<issue number>
```

or

```
DEPRECATED: <what is deprecated>
<BLANK LINE>
<deprecation description + recommended update path>
<BLANK LINE>
<BLANK LINE>
Closes #<pr number>
```

Breaking Change section should start with the phrase "BREAKING CHANGE: " followed by a summary of the breaking change, a blank line, and a detailed description of the breaking change that also includes migration instructions.

Similarly, a Deprecation section should start with "DEPRECATED: " followed by a short description of what is deprecated, a blank line, and a detailed description of the deprecation that also mentions the recommended update path.
chore(treewide): Add up-to-date license headers 2024-05-04 18:55:52 +00:00			`<!--`
			`Copyright (C) 2024 - 2024:`
chore(treewide): change license to GPL-3.0 or later To archive this, the previous MIT-License and its mentions were removed, COPYING was added, LICENSE.spdx and README were modified to show the correct license, sils@sils.li was added to the project's E-Mail adresses and ./scripts/renew_copyright_header.sh was executed. 2024-05-06 14:29:15 +00:00			`The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>`
			`SPDX-License-Identifier: GPL-3.0-or-later`
chore(treewide): Add up-to-date license headers 2024-05-04 18:55:52 +00:00
			`This file is part of Trinitrix.`

chore(treewide): Update the copyright headers 2024-05-08 19:18:29 +00:00			`Trinitrix is free software: you can redistribute it and/or modify`
			`it under the terms of the GNU General Public License as published`
			`by the Free Software Foundation, either version 3 of the License,`
			`or (at your option) any later version.`

			`This program is distributed in the hope that it will be useful,`
			`but WITHOUT ANY WARRANTY; without even the implied warranty of`
			`MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU`
			`General Public License for more details.`

			`You should have received a copy of the GNU General Public License`
			`along with this program. If not, see <https://www.gnu.org/licenses/>.`
chore(treewide): Add up-to-date license headers 2024-05-04 18:55:52 +00:00			`-->`

docs: added initial docs (README, LICENSE, commit message style) 2023-06-14 22:10:05 +00:00			`# Commit message style`
style(treewide): Format and improve the headers This commit represents one run of `./scripts/renew_copyright_headers.sh`. 2024-05-04 19:06:17 +00:00
Docs: fix the link in the commit message format docs 2023-07-19 23:24:01 +00:00			`This specification is heavily inspired by the [AngularJS commit message format](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format).`
docs: added initial docs (README, LICENSE, commit message style) 2023-06-14 22:10:05 +00:00
Docs: update the commit message format to a modified version of the AngularJS commit message style 2023-07-19 23:21:40 +00:00			`We have very precise rules over how our Git commit messages must be formatted.`
			`This format leads to easier to read commit history.`
docs: added initial docs (README, LICENSE, commit message style) 2023-06-14 22:10:05 +00:00
Docs: update the commit message format to a modified version of the AngularJS commit message style 2023-07-19 23:21:40 +00:00			`Each commit message consists of a header, a body (optional), and a footer (optional).`
docs: added initial docs (README, LICENSE, commit message style) 2023-06-14 22:10:05 +00:00
Docs: update the commit message format to a modified version of the AngularJS commit message style 2023-07-19 23:21:40 +00:00			```
			`<header>`
			`<BLANK LINE>`
			`<body>`
			`<BLANK LINE>`
			`<footer>`
			```
docs: added initial docs (README, LICENSE, commit message style) 2023-06-14 22:10:05 +00:00
Docs: update the commit message format to a modified version of the AngularJS commit message style 2023-07-19 23:21:40 +00:00			The `header` is mandatory and must conform to the _Commit Message Header format_ (described below).
docs: added initial docs (README, LICENSE, commit message style) 2023-06-14 22:10:05 +00:00
Docs: update the commit message format to a modified version of the AngularJS commit message style 2023-07-19 23:21:40 +00:00			The `body` is mandatory for all commits that are not 100% self explainatory.
			`When the body is present it must be at least 20 characters long and must conform to the _Commit Message Body format_.`
docs: added initial docs (README, LICENSE, commit message style) 2023-06-14 22:10:05 +00:00
Docs: update the commit message format to a modified version of the AngularJS commit message style 2023-07-19 23:21:40 +00:00			The `footer` is optional. The _Commit Message Footer format_ (described below) describes what the footer is used for and the structure it must have.
docs: added initial docs (README, LICENSE, commit message style) 2023-06-14 22:10:05 +00:00
Docs: update the commit message format to a modified version of the AngularJS commit message style 2023-07-19 23:21:40 +00:00			`## Commit Message Header`

			```
			`<type>(<scope>): <short summary>`
			`│ │ │`
			`│ │ └─⫸ Summary in present tense. Not capitalized. No period at the end.`
			`│ │`
			`│ └─⫸ Commit Scope: The name of the affected module.`
			`│`
			`└─⫸ Commit Type: Build\|Docs\|Feat\|Fix\|Perf\|Refactor\|Test\|Merge`
			```

			The `<type>` and `<summary>` fields are mandatory, the `(<scope>)` field is optional.

			`### type`

			`Must be one of the following:`

style(treewide): Format and improve the headers This commit represents one run of `./scripts/renew_copyright_headers.sh`. 2024-05-04 19:06:17 +00:00			`- 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`
			`- Test: Adding missing tests or correcting existing tests`
			`- Merge: A merging commit`
Docs: update the commit message format to a modified version of the AngularJS commit message style 2023-07-19 23:21:40 +00:00
			`### Scope`
style(treewide): Format and improve the headers This commit represents one run of `./scripts/renew_copyright_headers.sh`. 2024-05-04 19:06:17 +00:00
Docs: update the commit message format to a modified version of the AngularJS commit message style 2023-07-19 23:21:40 +00:00			`The scope should be the name of the module affected (as perceived by the person reading the changelog generated from commit messages).`

			`Specify submodules if needed!`

			`Example scopes:`

style(treewide): Format and improve the headers This commit represents one run of `./scripts/renew_copyright_headers.sh`. 2024-05-04 19:06:17 +00:00			- `app::events`
			- `ui`
Docs: update the commit message format to a modified version of the AngularJS commit message style 2023-07-19 23:21:40 +00:00
			When a commit affects the whole tree, use `treewide`.

			`### Summary`

			`Use the summary field to provide a succinct description of the change:`

style(treewide): Format and improve the headers This commit represents one run of `./scripts/renew_copyright_headers.sh`. 2024-05-04 19:06:17 +00:00			`- use the imperative, present tense: "change" not "changed" nor "changes"`
			`- don't capitalize the first letter`
			`- no dot (.) at the end`
Docs: update the commit message format to a modified version of the AngularJS commit message style 2023-07-19 23:21:40 +00:00
			`## Commit Message Body`

			`Just as in the summary, use the imperative, present tense: "fix" not "fixed" nor "fixes".`

			`Explain the motivation for the change in the commit message body. This commit message should explain _why_ you are making the change.`
			`You can include a comparison of the previous behavior with the new behavior in order to illustrate the impact of the change.`

			`This is not needed, if the summary is 100% self-explainatory.`

			`## Commit Message Footer`

			`The footer can contain information about breaking changes and deprecations and is also the place to reference issues and other PRs that this commit closes or is related to.`
			`For example:`

			```
			`BREAKING CHANGE: <breaking change summary>`
			`<BLANK LINE>`
			`<breaking change description + migration instructions>`
			`<BLANK LINE>`
			`<BLANK LINE>`
			`Fixes #<issue number>`
			```

			`or`

			```
			`DEPRECATED: <what is deprecated>`
			`<BLANK LINE>`
			`<deprecation description + recommended update path>`
			`<BLANK LINE>`
			`<BLANK LINE>`
			`Closes #<pr number>`
			```

			`Breaking Change section should start with the phrase "BREAKING CHANGE: " followed by a summary of the breaking change, a blank line, and a detailed description of the breaking change that also includes migration instructions.`

			`Similarly, a Deprecation section should start with "DEPRECATED: " followed by a short description of what is deprecated, a blank line, and a detailed description of the deprecation that also mentions the recommended update path.`