From 6db0445316246f60f859d43fa138c9b2083c20c2 Mon Sep 17 00:00:00 2001 From: Kevin Carter Date: Mon, 6 Apr 2015 10:38:40 -0500 Subject: [PATCH] Updating CONTRIBUTING for commit messages 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 --- CONTRIBUTING.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 705c7b79ab..16de332edb 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -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