From fb18f59114f2ec4bede6ded22ac8e299c867c4f9 Mon Sep 17 00:00:00 2001 From: Mathieu Arnold Date: Mon, 26 Apr 2021 17:58:55 +0200 Subject: 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(+) (limited to 'documentation/content/en/articles/committers-guide') 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). -- cgit v1.2.3