git: 811f291eae63 - main - - Update SpiritVNC to the latest version 0.4.6 - Drop the icon patch (had been merged upstream)

[Adriaan de Groot]

On Tuesday, 18 May 2021 05:02:05 CEST Alexey Dokuchaev wrote:
> commit 811f291eae631044b2919c6f3aa3a59c50bde639
> Author:     Alexey Dokuchaev <danfe at FreeBSD.org>
> AuthorDate: 2021-05-18 02:54:04 +0000
> Commit:     Alexey Dokuchaev <danfe at 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]
-------------- 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/20210518/28b77534/attachment.sig>