openstack/swift
Code Issues Proposed changes

added docs on specs workflow to CONTRIBUTING.md

Browse Source 
Change-Id: Id83d1da2a7a594a07fc5332b918539b3728e101b
This commit is contained in:
John Dickinson 2014-11-07 10:34:51 +01:00 committed by Matthew Oliver
parent 772dc5d059
commit fdcd20f2b6
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
CONTRIBUTING.md
View File

@ -17,7 +17,8 @@ Recommended workflow
* Set up a [Swift All-In-One VM](http://docs.openstack.org/developer/swift/development_saio.html). * Set up a [Swift All-In-One VM](http://docs.openstack.org/developer/swift/development_saio.html).
* Make your changes. * Make your changes. Docs and tests for your patch must land before
or with your patch.
* Run unit tests, functional tests, probe tests * Run unit tests, functional tests, probe tests
``./.unittests`` ``./.unittests``
@ -27,3 +28,17 @@ Recommended workflow
* Run ``tox`` (no command-line args needed) * Run ``tox`` (no command-line args needed)
* ``git review`` * ``git review``
Specs
=====
The [``swift-specs``](https://github.com/openstack/swift-specs) repo
can be used for collaborative design work before a feature is implemented.
Openstack's gerrit system is used to collaborate on the design spec. Once
approved Openstack provides a doc site to easily read these [specs](http://specs.openstack.org/openstack/swift-specs/)
A spec is needed for more impactful features. Coordinating a feature between
many devs (especially across companies) is a great example of when a spec is
needed. If you are unsure if a spec document is needed, please feel free to
ask in #openstack-swift on freenode IRC.