From 1aeecaedae24225aa9730551ee16f537429a2147 Mon Sep 17 00:00:00 2001 From: Thomas Koch Date: Tue, 7 Jan 2025 09:34:30 +0200 Subject: [PATCH] feat(docs/CONTRIBUTING.md): reference to Conventional Commits Change-Id: Ia0205ed51cbc717e4da438de1c0f6a3defa467f0 Reviewed-on: https://cl.tvl.fyi/c/depot/+/12962 Reviewed-by: tazjin Tested-by: BuildkiteCI --- docs/CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 70410d290..6fbe98dfd 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -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. +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 Multiple changes should be divided into multiple git commits whenever possible. @@ -118,3 +125,4 @@ review][] documentation. [magit]: https://magit.vc/ [Nix]: https://nixos.org/nix/ [code review]: ./REVIEWS.md +[Conventional Commits]: https://www.conventionalcommits.org