maurice/snix
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat(docs/CONTRIBUTING.md): reference to Conventional Commits

Browse source 
Change-Id: Ia0205ed51cbc717e4da438de1c0f6a3defa467f0
Reviewed-on: https://cl.tvl.fyi/c/depot/+/12962
Reviewed-by: tazjin <tazjin@tvl.su>
Tested-by: BuildkiteCI
This commit is contained in:
Thomas Koch 2025-01-07 09:34:30 +02:00 • committed by thk
parent b9e0a682ab
commit 1aeecaedae
1 changed files with 8 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/CONTRIBUTING.md
View file

@ -65,6 +65,13 @@ disambiguating. For example, when changing the configuration of the host
Please take a look at the existing commit log for examples. Please take a look at the existing commit log for examples.
This way of writing commit messages is known as [Conventional Commits][] and
should bring these advantages:
* automatic creation of changelogs from commit messages
* disciplined commit hygiene: one focused change per commit
* filtering of commit history by type
## Commit content ## Commit content
Multiple changes should be divided into multiple git commits whenever possible. Multiple changes should be divided into multiple git commits whenever possible.
@ -118,3 +125,4 @@ review][] documentation.
[magit]: https://magit.vc/ [magit]: https://magit.vc/
[Nix]: https://nixos.org/nix/ [Nix]: https://nixos.org/nix/
[code review]: ./REVIEWS.md [code review]: ./REVIEWS.md
[Conventional Commits]: https://www.conventionalcommits.org