qiurui
/
freebsd-doc
mirror of https://git.FreeBSD.org/doc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add a short section about commit message for ports. 

Reviewed by:	bapt
Differential Revision:	https://reviews.freebsd.org/D29994
This commit is contained in:
Mathieu Arnold 2021-04-26 17:58:55 +02:00
parent 1114f5f2d2
commit fb18f59114
No known key found for this signature in database
GPG Key ID: 29EB0902911D7E02
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
documentation/content/en/articles/committers-guide/_index.adoc
View File

@ -473,6 +473,33 @@ There is also a mirror on GitHub, see link:{handbook}mirrors/#mirrors[Exteral mi
The 'current' branch is 'main' .
The quarterly branches are named 'yyyyQn' for year 'yyyy' and quarter 'n'.
===== Commit message formats
A hook is available in the ports repository to help you write up your commit messages in https://cgit.freebsd.org/ports/tree/.hooks/prepare-commit-msg[.hooks/prepare-commit-message].
It can be enabled by running ``git config --add core.hooksPath .hooks``.
The main point being that a commit message should be formatted in the following way:
....
category/port: Summary.
Description of why the changes where made.
PR: 12345
....
[IMPORTANT]
====
The first line is the subject of the commit, it contains what port was changed, and a summary of the commit.
It should contain 50 characters or less.
A blank line should separate it from the rest of the commit message.
The rest of the commit message should be wrapped at the 72 characters boundary.
Another blank line should be added if there are any metadata fields, so that they are easily distinguishable from the commit message.
====
==== Managing Local Changes
This section addresses tracking local changes.
If you have no local changes, you can stop reading now (it is the last section and OK to skip).