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

Documentation: Fix wrong link to commit message guidelines

Browse source 
In the Gerrit guidelines there is an old link pointing to the retired
coreboot wiki (https://www.coreboot.org/Git#Commit_messages) when the
commit message guidelines are referenced. Indeed this section was never
ported over to the new documentation and is missing.

This commit rewrites this guidelines and adds them as a new section
based on what was in the wiki and updates the link accordingly.

Change-Id: I1cd2b13da6fe59697d677c7350d73eda5d486544
Signed-off-by: Werner Zeh <werner.zeh@siemens.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/85915
Reviewed-by: Maximilian Brune <maximilian.brune@9elements.com>
Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
Reviewed-by: Matt DeVillier <matt.devillier@gmail.com>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
This commit is contained in:
Werner Zeh 2025-01-09 09:58:12 +01:00 • committed by Matt DeVillier
commit d540e2a4fe
1 changed files with 48 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

49
Documentation/contributing/gerrit_guidelines.md
View file

@ -304,7 +304,7 @@ would be a good reviewer, look in the MAINTAINERS file or git history of
the files that you’ve changed, and add those people.
* Familiarize yourself with the coreboot [commit message
guidelines](https://www.coreboot.org/Git#Commit_messages), before pushing
guidelines](#commit-message-guidelines), before pushing
patches. This will help to keep annoying requests to fix your commit
message to a minimum.
@ -433,8 +433,55 @@ reversed after they come back.
Requests for clarification and suggestions for updates to these guidelines
should be sent to the coreboot mailing list at <coreboot@coreboot.org>.
Commit message guidelines
-------------------------
Git does not enforce a certain style for commit messages. For all aspects of
Git to work best with, it's important to follow these simple guidelines for
commit messages:
* The first line of the commit message consists of a short
(less than 65 characters, absolute maximum is 75) summary
* The second line is empty (no whitespace at all)
* The third and any following number of lines contains a longer description
of the commit as is necessary, including relevant background information
and quite possibly rationale for why the issue was solved in this particular
way. These lines should never be longer than 75 characters.
* The next line is empty (no whitespace at all)
* An optional TEST= line which describes the test that was done in order to
validate the patch
* An optional BUG= line to reference to a bug (of [coreboot's bug tracker] or any
other) this patch resolves
* The next line is empty if the optional lines are used
* A Change-Id: line to let Gerrit track this logical change
* A Signed-off-by: line according to [Signed-off-by policy](#sign-off-procedure)
Please do not create the Change-Id: and Signed-off-by: entries manually because
it is boring and error-prone. Instead, please install the commit-msg hook, e.g.
by running
```Bash
make gitconfig
```
in coreboot's top-level directory, and let the hook script do it for you.
And remember to always use
```Bash
git commit -s
```
to have git add your Signed-off-by: automatically.
When you write your commit message, please keep the following two hints in mind:
* If anyone involved in coreboot reads your comment in a year or so, they
shall still be able to understand what your commit is about, without the need
to analyze the code.
* Double-check that you are really committing what you think you are, e.g. by
typing the following in the top-level coreboot directory:
```Bash
git show
```
[ready changes]: https://review.coreboot.org/q/age:1d+project:coreboot+status:open+is:mergeable+label:All-Comments-Resolved%253Dok+label:Code-Review%253D2+-label:Code-Review%253C0+label:Verified%253D1+-label:Verified-1
[Developer's Certificate of Origin 1.1]: https://developercertificate.org/
[Creative Commons Attribution-ShareAlike 2.5 License]: https://creativecommons.org/licenses/by-sa/2.5/
[this LKML thread]: https://lkml.org/lkml/2004/5/23/10
[SCO-Linux disputes]: https://en.wikipedia.org/wiki/SCO%E2%80%93Linux_disputes
[coreboot's bug tracker]: https://ticket.coreboot.org/