Commit Messages and Release Notes
50 views
Skip to first unread message
Alexander Ljungberg
Dec 21, 2012, 6:32:22 AM12/21/12
to objecti...@googlegroups.com
Hello everyone,
While as always your commits are greatly appreciated, I'd just like to remind everyone about the importance of your commit messages. If it's not clear from the message if your change is a fix or an improvement and what it fixes or improves it becomes very hard to review changes made in the past.
Unclear commits might not be included correctly in the release notes, or might be omitted. This inconveniences users who're looking for particular fixes or want to learn about a new release.
With this in mind I've written some suggested commit message guidelines here:
https://github.com/cappuccino/cappuccino/blob/master/CONTRIBUTING.md#commit-messages
The git log is for anyone reviewing git log or git blame to figure out parts of the code. If we keep it neat and clean that helps end users and developers alike.
Alexander
While as always your commits are greatly appreciated, I'd just like to remind everyone about the importance of your commit messages. If it's not clear from the message if your change is a fix or an improvement and what it fixes or improves it becomes very hard to review changes made in the past.
Unclear commits might not be included correctly in the release notes, or might be omitted. This inconveniences users who're looking for particular fixes or want to learn about a new release.
With this in mind I've written some suggested commit message guidelines here:
https://github.com/cappuccino/cappuccino/blob/master/CONTRIBUTING.md#commit-messages
The git log is for anyone reviewing git log or git blame to figure out parts of the code. If we keep it neat and clean that helps end users and developers alike.
Alexander
Reply all
Reply to author
Forward
0 new messages