openstack/training-guides
Code Issues Proposed changes

[upstream] update Git commit message conventions

Browse Source 
Change-Id: I55b1fbfd20c14c865f7ddf28c9fcc3e752749206
This commit is contained in:
KATO Tomoyuki 2016-10-26 21:49:20 +09:00
parent b7717a2494
commit 59329b5320
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/upstream-training/source/slides/workflow-commit-message.rst
View File

@ -34,8 +34,10 @@ Good: new API + new feature
Contents of a Commit Message (Summary Line) Contents of a Commit Message (Summary Line)
=========================================== ===========================================
- Limited to 50 characters
- Succinctly describes patch content - Succinctly describes patch content
- Verb in the present tense and object
- Limited to 50 characters
- Should not end with a period
Contents of a Commit Message (Body) Contents of a Commit Message (Body)
=================================== ===================================
@ -44,6 +46,7 @@ Contents of a Commit Message (Body)
- Explanation of issue being solved and why it should be fixed - Explanation of issue being solved and why it should be fixed
- Explain how problem is solved - Explain how problem is solved
- Other possible content - Other possible content
- Does it improve code structure? - Does it improve code structure?
- Does it fix limitations of the current code? - Does it fix limitations of the current code?
- References to other relevant patches? - References to other relevant patches?