[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Bug-wget] New Commit Guidelines

From: Darshit Shah
Subject: [Bug-wget] New Commit Guidelines
Date: Fri, 12 Dec 2014 11:30:37 +0530

Hi Everyone,

In the past we have debated on the usefulness of maintaining a
ChangeLog file with every single commit. Recently, we decided to do
away with this practice and instead use the gitlog-to-changelog script
provided by Gnulib.

Hence, from now onwards, no commit should be pushed with a ChangeLog
entry. Instead, the commit messages should now be more detailed and
reflect the changes in a format that can be nicely converted to a
ChangeLog format.

The commit messages should adhere to the following set of guidelines,
and Giuseppe, Tim and Me should be careful to edit the commit messages
to ensure that the following are always met:

* Commit messages should follow the 80 character per line rule. This
is a little obsolete on modern hi-res systems, but is still important
in a variety of cases.
* The first line of the commit message should list the file / higher
level concept that is being worked on in the commit, followed by a
colon and a one line explanation. E.g:
openssl: Support ALPN Negotiation
* Based on the guidelines for formatting git commit messages, the
gitlog-to-changelog script also expects that additional information
about the commit be available in a paragraph after a linebreak. E.g:

openssl: Support ALPN Negotiation

HTTP/2 requires the protocol negitiation to occur through SSL ALPN.
Implement support for such protocol negotiation.

All existign ChangeLog files will be renamed and made read-only. The
new ChangeLog file will be generated just before each new release
through the gitlog script.

Thanking You,
Darshit Shah

reply via email to

[Prev in Thread] Current Thread [Next in Thread]