From ab3f58b3a3e7b38940cf27b65111847c5276ff35 Mon Sep 17 00:00:00 2001 From: Michael Vetter Date: Mon, 9 Mar 2026 13:32:05 +0100 Subject: [PATCH] docs: Add information about footers in git commit messages --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index befed7ff..da368b07 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -81,6 +81,28 @@ Common types are: Example: `fix(omemo): resolve trust check issues` +The **footer** is used for metadata and automation: +- `Fixes: #123`: Links to an issue and automatically closes it when merged. +- `Ref: `: References a related commit. +- `See-also: `: Links to external documentation or discussion. +- `Co-authored-by: Name `: Credits multiple authors. +- `BREAKING CHANGE:`: Starts with this phrase to signal a major change that breaks backward compatibility. + +Full Example: +```text +feat(omemo): add support for QR code trust verification + +This adds a new command `/omemo qrcode` that displays a QR code +of the current identity key for easier out-of-band verification. + +BREAKING CHANGE: The 'libqrencode' library is now a required dependency. + +Fixes: #2105 +Ref: a26cdf386bfec381563294342f2152a5c0eb677e +See-also: https://xmpp.org/extensions/xep-0384.html +Co-authored-by: Another Dev +``` + ### GitHub We would like to encourage people to use GitHub to create pull requests. It makes it easy for us to review the patches, track WIP branches, organize branches with labels and milestones,