openstack/openstack-ansible
Code Issues Proposed changes

Updating CONTRIBUTING for commit messages

Browse Source 
Updated CONTRIBUTING to mention how commit messages should be written.
Presently the guidlines are missing information on how commit messages
should be written. This update simply notes that we follow upstream
openstack practices and mentions that the `GitCommitMessages` wiki
page provides all the information required to write good commit
messages.

Change-Id: I30e04da38cac4720c41418ae44da5d26c6761174
This commit is contained in:
Kevin Carter 2015-04-06 10:38:40 -05:00
parent 4544f00783
commit 6db0445316
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.rst
View File

@ -35,6 +35,7 @@ Triaging bugs:
Submitting Code
---------------
* Write good commit messages. We follow the OpenStack "`Git Commit Good Practice`_" guide. if you have any questions regarding how to write good commit messages please review the upstream OpenStack documentation.
* Changes to the project should be submitted for review via the Gerrit tool, following the `workflow documented here`_.
* Pull requests submitted through GitHub will be ignored and closed without regard.
* All feature additions/deletions should be accompanied by a blueprint/spec. IE: adding additional active agents to neutron, developing a new service role, etc...
@ -92,6 +93,7 @@ Example what **NOT** to do:
Usage of the ">" and "|" operators should be limited to Ansible conditionals and command modules such as the Ansible ``shell`` or ``command``.
.. _Git Commit Good Practice: https://wiki.openstack.org/wiki/GitCommitMessages
.. _workflow documented here: http://docs.openstack.org/infra/manual/developers.html#development-workflow
.. _upstream OpenStack Blueprint documentation: https://wiki.openstack.org/wiki/Blueprints
.. _advanced gerrit usage and dependent changes can be found here: http://www.mediawiki.org/wiki/Gerrit/Advanced_usage