Date: Tue, 18 May 2021 11:14:17 +0200 From: Adriaan de Groot <adridg@freebsd.org> To: ports-committers@freebsd.org, dev-commits-ports-all@freebsd.org, dev-commits-ports-main@freebsd.org Subject: Re: git: 811f291eae63 - main - - Update SpiritVNC to the latest version 0.4.6 - Drop the icon patch (had been merged upstream) Message-ID: <5573921.Zv9zXsTiuT@beastie.bionicmutton.org> In-Reply-To: <202105180302.14I325TY017885@gitrepo.freebsd.org>
index | next in thread | previous in thread | raw e-mail
[-- Attachment #1 --]
On Tuesday, 18 May 2021 05:02:05 CEST Alexey Dokuchaev wrote:
> commit 811f291eae631044b2919c6f3aa3a59c50bde639
> Author: Alexey Dokuchaev <danfe@FreeBSD.org>
> AuthorDate: 2021-05-18 02:54:04 +0000
> Commit: Alexey Dokuchaev <danfe@FreeBSD.org>
> CommitDate: 2021-05-18 02:56:58 +0000
>
> - Update SpiritVNC to the latest version 0.4.6
> - Drop the icon patch (had been merged upstream)
Hi! This is a reminder, to everyone ("you" in the text below is not the
committer of what I'm replying to, but "anyone reading this, who might be
contributing to FreeBSD ports and writing git commit messages"), sent at most
once per calendar week (currently week 20), to please use conventional commit
messages. A conventional commit message is one that meets the conventions --
social norms, regular practice, whatever -- for good communication.
Commit messages are seen in lots of contexts, such as email, cgit, git log,
qgit and gitk, and the tools make certain assumptions because of conventions
in git commit messages that go back ten years or more.
The conventional format for commit messages in git overall is:
<summary-what>
<blank line>
<explanation>
You can see this format described in the manpage for git-commit(1), in the
section "DISCUSSION". You'll note there that the format is described as "not
required" and "a good idea". The "good idea" is that you're communicating with
other ports committers through your commit message.
For FreeBSD, the conventional format is slightly more specific, and it 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.
The committers guide mentions the format and the hook and how to set it up at
https://docs.freebsd.org/en/articles/committers-guide/#_commit_message_formats
You can configure git-log with a wide variety of formatting options. See for
instance git-log(1), section "PRETTY FORMATS". The formatting placeholders %s
and %b (subject and body) refer to the first line, and the remainder of the
commit message. If seeing the subject (which, conventionally, tells you what
was changed) annoys you and you prefer SVN-style lists of files, you might try
something like `git log --format=format:"%h %an%n%b" --name-status` which you
can add as an alias to `.gitconfig`.
For some background, or discussion of how other projects do things (but keep
in mind that ports are an unusual collection: hundreds of committers that
**mostly** only work on their own "stuff"), here's a reading list:
https://chris.beams.io/posts/git-commit/#seven-rules
https://community.kde.org/Infrastructure/GitLab#Write_a_good_commit_message
https://blogs.gnome.org/danni/2011/10/25/a-guide-to-writing-git-commit-messages/
https://wiki.gnome.org/Git/CommitMessages
Thank you for communicating clearly.
[ade]
[-- Attachment #2 --]
-----BEGIN PGP SIGNATURE-----
iQGzBAABCAAdFiEEhrjttu2OP5apuuy1z93JbxKxkVwFAmCjhWkACgkQz93JbxKx
kVybygv+K/asStRPSWZyG4iNd7+1o9nArJhHhX2qmy9Dnl963bFrrsg0cCcwR7lP
Z0+DWAKsn/QZ4OfUW1in2h2TZZpGgkjxrKIvKXghonMmwhlCOmMHtjurc6V/NqNz
FgVA1Z5ymzM84Rl7/Pc3E4gCjzErwBhpxRTvEaoOQZtWTVeco0UgvsBzS9QsFL++
7DTpRzn5fgO0h0wpTZWUNKqDqo7FKGlbygpIuRIzd2Ak7pAhXI3OYKT7oimO8RAh
0iJ3EFlL0CzJiWIlwR8TcL2ua7W7AH1AJo4HqA22sGx1q2legKl9EsJzefUalPAr
HtNAMPIupjI9hb/0G+CjTbhwsBlbGuMUkCreJnVN5mirp5B7ezlRipAqbQ9fwLIM
ZbncUGwawsbC3j9fbuhiDBqye3gFKPzw89ae7QARFV9E5hbHMOCh74755LEBJdgh
aA3J1EMf6jDXzclV+M255gtNVV5dZUlsZNF5UEUq35Mq5YCtfl8ov93tyH07xqcc
WLqQ9id5
=b9gq
-----END PGP SIGNATURE-----
home |
help
Want to link to this message? Use this
URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?5573921.Zv9zXsTiuT>