From 6acf07022d8f996de91ff39323a5d271f4269b63 Mon Sep 17 00:00:00 2001 From: Nicholas Sudsgaard Date: Thu, 14 Aug 2025 21:12:08 +0900 Subject: [PATCH] Doc/contributing: Add clarification on how to reference other commits This should address the following open action item from the coreboot leadership meetings[1]: > Add clarification to docs, "do not use gerrit change-id or CB: format > in reference to already-merged patches". [1] https://mail.coreboot.org/archives/list/coreboot@coreboot.org/thread/YCA55MINAFK5M56OAUA2NMM7WDMDEGXI/ Change-Id: Ie742caca70e284254bb7f8a070c3a441b6a80c58 Signed-off-by: Nicholas Sudsgaard Reviewed-on: https://review.coreboot.org/c/coreboot/+/88776 Reviewed-by: Paul Menzel Reviewed-by: Matt DeVillier Tested-by: build bot (Jenkins) --- Documentation/contributing/git_commit_messages.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Documentation/contributing/git_commit_messages.md b/Documentation/contributing/git_commit_messages.md index a007b2a20c..fc53bdb148 100644 --- a/Documentation/contributing/git_commit_messages.md +++ b/Documentation/contributing/git_commit_messages.md @@ -47,8 +47,9 @@ to go over everything again. There are other tutorials that cover that. - Make sure the problem being solved by the commit is described. While it may be obvious to the committer, it may not be obvious to others. -- Reference other commits with either CB:XXXXX or a 10 character hash - and the subject. +- When referencing other commits use a 12 character hash and the subject + (e.g. `commit XXXXXXXXXXXX ("some commit")`). However, use `CB:XXXXX` + when referring to an open or abandoned change on Gerrit. - When using a URL in a commit message, use archive.org when possible. URLs often get changed or go stale, so this keeps them stable. - Make sure that all changes in a patch are addressed in the commit