Skip to content

Commit

Permalink
added docs on specs workflow to CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Change-Id: Id83d1da2a7a594a07fc5332b918539b3728e101b
  • Loading branch information
notmyname authored and matthewoliver committed Nov 7, 2014
1 parent 772dc5d commit fdcd20f
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ Recommended workflow

* 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
``./.unittests``
Expand All @@ -27,3 +28,17 @@ Recommended workflow
* Run ``tox`` (no command-line args needed)

* ``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.

0 comments on commit fdcd20f

Please sign in to comment.