Date: Tue, 27 Apr 2021 06:15:41 GMT From: Mathieu Arnold <mat@FreeBSD.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org Subject: git: fb18f59114 - main - Add a short section about commit message for ports. Message-ID: <202104270615.13R6Ff5t073524@gitrepo.freebsd.org>
index | next in thread | raw e-mail
The branch main has been updated by mat: URL: https://cgit.FreeBSD.org/doc/commit/?id=fb18f59114f2ec4bede6ded22ac8e299c867c4f9 commit fb18f59114f2ec4bede6ded22ac8e299c867c4f9 Author: Mathieu Arnold <mat@FreeBSD.org> AuthorDate: 2021-04-26 15:58:55 +0000 Commit: Mathieu Arnold <mat@FreeBSD.org> CommitDate: 2021-04-27 06:14:40 +0000 Add a short section about commit message for ports. Reviewed by: bapt Differential Revision: https://reviews.freebsd.org/D29994 --- .../en/articles/committers-guide/_index.adoc | 27 ++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc index ecdfb633ad..63a4e70f38 100644 --- a/documentation/content/en/articles/committers-guide/_index.adoc +++ b/documentation/content/en/articles/committers-guide/_index.adoc @@ -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).home | help
Want to link to this message? Use this
URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202104270615.13R6Ff5t073524>