other: change commit msg format to use lowercase tags and desc. start

This commit is contained in:
June 2024-09-11 02:50:03 +02:00
parent 126ebfa9db
commit e374ad85b1
No known key found for this signature in database

View File

@ -9,22 +9,22 @@ For code of this repo in `.js` files, stick to a textwidth of 80.
The commit message format is as follows: The commit message format is as follows:
``` ```
Tag: Short description tag: short description
Longer description here if necessary Longer description here if necessary
``` ```
The `Tag` should be one of the following: The `tag` should be one of the following:
- `Fix` - for a bug fix. - `fix` - for a bug fix.
- `Update` - for a backwards compatible enhancement. - `update` - for a backwards compatible enhancement.
- `Feature` (formerly also `New`) - for a new feature. - `feature` (formerly also `New`) - for a new feature.
- `Breaking` - for a backwards-incompatible enhancement or feature. - `breaking` - for a backwards-incompatible enhancement or feature.
- `Perf` - for a code change that improves performance. - `perf` - for a code change that improves performance.
- `Refactor` - for a code change that neither fixes a bug nor adds a feature (nor is `Perf`). - `refactor` - for a code change that neither fixes a bug nor adds a feature (nor is `perf`).
- `Build` - for changes that affect the build system or external dependencies. - `build` - for changes that affect the build system or external dependencies.
- `Test` - for adding or correcting tests. - `test` - for adding or correcting tests.
- `Docs` - for changes to documentation only. - `docs` - for changes to documentation only.
- `Other` - for anything that isn't covered by the tags above. - `other` - for anything that isn't covered by the tags above.
Those tags are an adapted version of the tags eslint (<https://eslint.org/docs/developer-guide/contributing/pull-requests#step-2-make-your-changes>) and of the tags Angular (<https://github.com/angular/angular/blob/master/CONTRIBUTING.md#type>) uses. Those tags are an adapted version of the tags eslint (<https://eslint.org/docs/developer-guide/contributing/pull-requests#step-2-make-your-changes>) and of the tags Angular (<https://github.com/angular/angular/blob/master/CONTRIBUTING.md#type>) uses.