From owner-dev-commits-doc-all@freebsd.org Tue Apr 27 06:15:41 2021 Return-Path: Delivered-To: dev-commits-doc-all@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id D0F2E621F3A for ; Tue, 27 Apr 2021 06:15:41 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4FTs2P5brzz3Jl3; Tue, 27 Apr 2021 06:15:41 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id B300E15EA4; Tue, 27 Apr 2021 06:15:41 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 13R6FfPj073525; Tue, 27 Apr 2021 06:15:41 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 13R6Ff5t073524; Tue, 27 Apr 2021 06:15:41 GMT (envelope-from git) Date: Tue, 27 Apr 2021 06:15:41 GMT Message-Id: <202104270615.13R6Ff5t073524@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Mathieu Arnold Subject: git: fb18f59114 - main - Add a short section about commit message for ports. MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: mat X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: fb18f59114f2ec4bede6ded22ac8e299c867c4f9 Auto-Submitted: auto-generated X-BeenThere: dev-commits-doc-all@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Commit messages for all branches of the doc repository List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 27 Apr 2021 06:15:41 -0000 The branch main has been updated by mat: URL: https://cgit.FreeBSD.org/doc/commit/?id=fb18f59114f2ec4bede6ded22ac8e299c867c4f9 commit fb18f59114f2ec4bede6ded22ac8e299c867c4f9 Author: Mathieu Arnold AuthorDate: 2021-04-26 15:58:55 +0000 Commit: Mathieu Arnold 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).