diff options
author | Ryan Petrello <lists@ryanpetrello.com> | 2013-08-13 15:33:29 -0400 |
---|---|---|
committer | Ryan Petrello <lists@ryanpetrello.com> | 2013-08-13 15:40:20 -0400 |
commit | 106ba3afbaa321f080ce57e9a7a303ca6c303eed (patch) | |
tree | 5534118701c30b4e218760d90a0496003b80783b /CONTRIBUTING.rst | |
parent | 6086f0f84ed9e2ab3c53f940e4233c94fa446314 (diff) | |
download | pecan-106ba3afbaa321f080ce57e9a7a303ca6c303eed.tar.gz |
Update docs and package metadata to reflect gerrit review process.
Change-Id: I5cc6cfa31bb899ea32f6d9cb37d86dc0275d09fc
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r-- | CONTRIBUTING.rst | 39 |
1 files changed, 31 insertions, 8 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 0d0eece..733d3c8 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,12 +1,32 @@ Contributing to Pecan --------------------- -To fix bugs or add features to Pecan, a GitHub account is required. +Pecan uses the Gerrit code review system for bug fixes and feature additions. -The general practice for contributing is to `fork Pecan -<http://help.github.com/fork-a-repo/>`_ and make changes in the ``next`` -branch. When you're finished, `send a pull request -<http://help.github.com/send-pull-requests/>`_ and the developers will review -your patch. +**Pull requests submitted through GitHub will be ignored.** + +To contribute: + + * Visit `review.openstack.org <http://review.openstack.org>`_ and click the + *Sign In* link at the top-right corner of the page. Log in with your + Launchpad ID (or register a new account). + * ``$ git clone`` pecan locally and create a `topic branch + <http://git-scm.com/book/ch3-4.html#Topic-Branches>`_ to hold your work. + The general convention when working on bugs is to name the branch + ``bug/BUG-NUMBER`` (e.g., ``bug/1234567``). Otherwise, give it + a meaningful name because it will show up as the topic for your change in + Gerrit. + * Commit your work and submit a review (``$ git review``) + +:: + + $ git clone https://github.com/stackforge/pecan.git && cd pecan + $ git checkout -b bug/1234 + $ pip install git-review && git review -s + # Make changes + $ pip install tox && tox + $ git add . + $ git commit -a + $ git review All contributions must: @@ -14,7 +34,10 @@ All contributions must: * Include narrative and API documentation if new features are added. * Be (generally) compliant with `PEP8 <http://www.python.org/dev/peps/pep-0008/>`_. - * Not break the test or build. Before issuing a pull request, ``$ pip + * Not break the test or build. Before submitting a review, ``$ pip install tox && tox`` from your source to ensure that all tests still pass across multiple versions of Python. - * Add your name to the (bottom of the) AUTHORS file. + +Bugs should be filed on Launchpad, not GitHub: + +https://bugs.launchpad.net/pecan |