june/Top-Bar-Organizer
1
0
Fork 0
mirror of https://gitlab.gnome.org/june/top-bar-organizer.git synced 2026-01-10 16:26:35 +01:00
Code Issues Projects Releases Packages Wiki Activity

Docs: Specify commit message format

Browse source 
Add initial `CONTRIBUTING.md` specifying the commit message format to
use.
This commit is contained in:
June 2021-05-14 13:17:52 +02:00
commit 1f1a958555
No known key found for this signature in database
GPG key ID: 094C2AC34192FA11
1 changed files with 26 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

26
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,26 @@
# Contributing
## Commit Message Format
The commit message format is as follows:
```
Tag: Short description
Longer description here if necessary
```
The `Tag` should be one of the following:
- `Fix` - for a bug fix.
- `Update` - for a backwards compatible enhancement.
- `Feature` - for a new feature.
- `Breaking` - for a backwards-incompatible enhancement or feature.
- `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`).
- `Build` - for changes that affect the build system or external dependencies.
- `Test` - for adding or correcting tests.
- `Docs` - for changes to documentation only.
- `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.