openstack/placement
Code Issues Proposed changes

Expand HACKING with commit message guidelines

Browse Source 
Add a 'Commit Messages' section to HACKING describing how a commit
message should be formed.

Change-Id: I29b69022dfbdac09523eaa5cef3fc1a4550a7c5f
This commit is contained in:
Brian Waldon 2012-06-28 10:28:29 -07:00
parent a8bb37e316
commit 657b6c42fe
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
HACKING.rst
View File

@ -213,3 +213,24 @@ with the help of openstack-common's update.py script. See:
The copy of the code should never be directly modified here. Please
always update openstack-common first and then run the script to copy
the changes across.
Commit Messages
---------------
Using a common format for commit messages will help keep our git history
readable. Follow these guidelines:
First, provide a brief summary (limited to 50 chars).
The first line of the commit message should provide an accurate
description of the change, not just a reference to a bug or
blueprint. It must be followed by a single blank line.
Following your brief summary, provide a more detailed description of
the patch, manually wrapping the text at 72 characters. This
description should provide enough detail that one does not have to
refer to external resources to determine its high-level functionality.
Once you use 'git review', two lines will be appended to the commit
message: a blank line followed by a 'Change-Id'. This is important
to correlate this commit with a specific review in Gerrit, and it
should not be modified.