openstack/training-guides
Code Issues Proposed changes

changes to commit-message.rst

Browse Source 
removed all caps from GIT
fixed misspelling of occasionally
made other plural and added commit
removed extra spaces

Change-Id: Ia0ddfb788fa482610fb0c91720885f9aa1cc7947
This commit is contained in:
Shilla Saebi 2014-09-19 15:30:08 -04:00
parent 2dd44182f3
commit 73417e0b0e
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/upstream-training/17-commit-message.rst
View File

@ -1,11 +1,11 @@
Commit messages Commit messages
=============== ===============
- quality of the OpenStack GIT history - quality of the OpenStack git history
- carrot by alerting people to the benefits - carrot by alerting people to the benefits
- anyone doing Gerrit code review can act as the stick - anyone doing Gerrit code review can act as the stick
- review the commit message, not just code - review the commit message, not just the code
- Developers read mostly, write occassionally - Developers read mostly, write occasionally
---- ----
@ -28,21 +28,21 @@ Things to avoid
---- ----
Bad : two independent changes Bad: two independent changes
============================= =============================
.. image:: ./_assets/17-01-bad-two.png .. image:: ./_assets/17-01-bad-two.png
---- ----
Bad : new feature and refactor Bad: new feature and refactor
============================== ==============================
.. image:: ./_assets/17-02-bad-new.png .. image:: ./_assets/17-02-bad-new.png
---- ----
Good : new API + new feature Good: new API + new feature
============================ ============================
.. image:: ./_assets/17-03-good.png .. image:: ./_assets/17-03-good.png
@ -104,5 +104,5 @@ GIT commit message structure
Exercise Exercise
======== ========
review each other messages on the draft Review each other’s commit messages on the draft