erebion/coreboot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Doc/contributing: Add clarification on how to reference other commits

Browse source 
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 <devel+coreboot@nsudsgaard.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/88776
Reviewed-by: Paul Menzel <paulepanter@mailbox.org>
Reviewed-by: Matt DeVillier <matt.devillier@gmail.com>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
This commit is contained in:
Nicholas Sudsgaard 2025-08-14 21:12:08 +09:00 • committed by Matt DeVillier
commit 6acf07022d
1 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
Documentation/contributing/git_commit_messages.md
View file

@ -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