Date: Thu, 29 Apr 2021 04:10:06 +0000 From: Alexey Dokuchaev <danfe@freebsd.org> To: Rene Ladan <rene@freebsd.org> Cc: Adriaan de Groot <adridg@freebsd.org>, ports-committers@freebsd.org, dev-commits-ports-all@freebsd.org, dev-commits-ports-main@freebsd.org Subject: Re: Please use conventional commit messages (Re: git: 2a9b7ca2a362) Message-ID: <YIoxngK293p072XF@FreeBSD.org> In-Reply-To: <YIlYqNdVF9gfO0D7@freefall.freebsd.org> References: <202104281017.13SAHDF2019723@gitrepo.freebsd.org> <2794032.slGk94SIus@beastie.bionicmutton.org> <YIlMysgKhvtgeirW@FreeBSD.org> <YIlYqNdVF9gfO0D7@freefall.freebsd.org>
next in thread | previous in thread | raw e-mail | index | archive | help
On Wed, Apr 28, 2021 at 12:44:24PM +0000, Rene Ladan wrote: > On Wed, Apr 28, 2021 at 11:53:46AM +0000, Alexey Dokuchaev wrote: > > On Wed, Apr 28, 2021 at 12:36:39PM +0200, Adriaan de Groot wrote: > > > On Wednesday, 28 April 2021 12:17:13 CEST Alexey Dokuchaev wrote: > > > > commit 2a9b7ca2a3620249bfad050ac3eee6d859926213 > > > > ... > > > > > > > > Update `www/web2ldap' to version 1.5.117. > > > > > > Please use conventional commit messages, [...] Forgot to mention: this "conventional" format of yours adds really a lot of noise to the "git log ." output which in turn makes history harder to study and navigate around. Extra blank lines pessimize it even further. > > I think it is conventional enough. I'd prefer it even better without > > the embedded port name, but I guess I can buy the reasoning why people > > want to see it there. As for its position, I find "foo/bar: blah" > > inconvenient, unnatural, and hard to read. > > This just makes scanning commit mails harder. The problem here is very poor git's default commit email template, and duplicating metainformation that can be automatically inferred from the commit is conceptually wrong. Subject line should contain commit identifier, branch name, and a list of files, directories, or the top directory of the commit. Subversion did this right, FWIW. Take a look at old commit logs in comparison and notice how cleaner and better they were. Li-Wen told me that they are working on improving email template (as it has other deficiencies as well), so let's hope this issue would be fixed at the proper level and people won't have to write idiotic subject-like lines in their commit logs. ./danfe
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?YIoxngK293p072XF>