Please use conventional commit messages (Re: git: 2a9b7ca2a362)

Adriaan de Groot adridg at freebsd.org
Wed Apr 28 10:36:43 UTC 2021


On Wednesday, 28 April 2021 12:17:13 CEST Alexey Dokuchaev wrote:
> commit 2a9b7ca2a3620249bfad050ac3eee6d859926213
> Author:     Alexey Dokuchaev <danfe at FreeBSD.org>
> AuthorDate: 2021-04-28 10:16:16 +0000
> Commit:     Alexey Dokuchaev <danfe at FreeBSD.org>
> CommitDate: 2021-04-28 10:16:32 +0000
> 
>     Update `www/web2ldap' to version 1.5.117.

Please use conventional commit messages, for consistency with the rest of the 
ports commits and convenience for consumers -- humans looking at commits 
through tools like email, qgit and gitk (desktop-applications), cgit (git-web 
browser) and git log (CLI).

The conventional format for commit messages in git overall is:

<summary-what>
<blank line>
<explanation>

For FreeBSD, this is slightly more specific, and the conventional format is 
(with a bunch of details I'm ommitting here in this friendly reminder):

<category>/<portname>: <what>
<blank line>
<explanation>

You can configure a git-commit hook to help remind you of the conventional 
format; this can be done on a per-repository basis if you work on multiple 
repositories with differing social conventions.

Recent discussions of commit-message formatting may be found on the ports 
list, including threads "New port: regather is an LDAP syncrepl consumer which 
can perform various actions based on LDAP syncrepl events." and "[HEADSUP] git 
hooks" and "Ports tree have been migrated to git".

[ade]
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: This is a digitally signed message part.
URL: <http://lists.freebsd.org/pipermail/dev-commits-ports-all/attachments/20210428/639066f0/attachment.sig>


More information about the dev-commits-ports-all mailing list