Remove the commit message guideline
We're not following them anyway!
This commit is contained in:
parent
c439cfe947
commit
d5ec2e3203
1 changed files with 0 additions and 23 deletions
|
@ -2,26 +2,3 @@
|
||||||
|
|
||||||
>`@todo` Write the contribution guide.
|
>`@todo` Write the contribution guide.
|
||||||
|
|
||||||
## Commit messages
|
|
||||||
|
|
||||||
Our commit message format is as follows:
|
|
||||||
|
|
||||||
```
|
|
||||||
[Tag]: Short description (fixes #1234)
|
|
||||||
|
|
||||||
Longer description here if necessary
|
|
||||||
```
|
|
||||||
|
|
||||||
The first line of the commit message (the summary) must have a specific format. This format is checked by our build tools.
|
|
||||||
|
|
||||||
The `[Tag]` is one of the following:
|
|
||||||
|
|
||||||
* `Fix` - for a bug fix.
|
|
||||||
* `Update` - either for a backwards-compatible enhancement.
|
|
||||||
* `New` - implemented a new feature.
|
|
||||||
* `Breaking` - for a backwards-incompatible enhancement or feature.
|
|
||||||
* `Docs` - changes to documentation only.
|
|
||||||
* `Build` - changes to build process only.
|
|
||||||
* `Upgrade` - for a dependency upgrade.
|
|
||||||
* `Chore` - for refactoring, adding tests, etc. (anything that isn't user-facing).
|
|
||||||
* `WIP` - for a work in progress
|
|
Loading…
Reference in a new issue