No problem, I'll use that template.
-Brad
On 2/16/18 2:52 AM, Daniel Stenberg wrote:
> Hi team,
>
> I would like to propose a stricter approach on how to write commit messages in this project. I'm personally very happy
> with the format we use in the curl project and that's where the template below comes from.
>
> The primary principle is that the first line should better explain for which area the fix concerns + what the fix is.
> Ideally, that first single line works as-is as a bullet point in the future RELEASE-NOTES. So it still needs to be short.
>
> This code, and our commit messages, will be around for a long time. We want to be able to read these changes and refer
> to these commits ten years down the line. Or twenty.
>
> ---- start ----
> [area]: [short line describing the main effect, no more than 70 columns]
> -- empty line --
> [full description, no wider than 72 columns that describe as much as
> possible as to why this change is made, and possibly what things
> it fixes and everything else that is related]
> -- empty line --
> [Closes/Fixes #1234 - if this closes or fixes a github issue]
> [Bug: URL to source of the report or more related discussion]
> [Reported-by: John Doe - credit the reporter]
> [whatever-else-by: credit all helpers, finders, doers]
> ---- stop ----
>
> Thoughts? (I've used this style personally for a very long time so it should at least feel familiar.)
>
Received on 2018-02-16