From fdcd20f2b6496a9e857cb47ae8907938033be9df Mon Sep 17 00:00:00 2001 From: John Dickinson Date: Fri, 7 Nov 2014 10:34:51 +0100 Subject: [PATCH] added docs on specs workflow to CONTRIBUTING.md Change-Id: Id83d1da2a7a594a07fc5332b918539b3728e101b --- CONTRIBUTING.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 368e9cdeab..c31931aadb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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`` @@ -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.