Add Spec Lifecycle Rules to readme

This change adds a new section, Spec Lifecycle Rules, to the README.
I am raising them here for discussion and are based on spec
discussions at summit.

If anyone can think of better working, section name or some more
rules please leave comments.

Change-Id: I5dda349f9e3ce2a49d400eefa275301d5f2d693d
This commit is contained in:
Matthew Oliver 2015-06-10 18:21:45 +10:00
parent 010e14730c
commit 54f22c8fb9
1 changed files with 17 additions and 0 deletions

View File

@ -35,6 +35,23 @@ approved and merged as soon as possible, and spec documents in the
moved to the ``done`` directory. If a feature needs a spec, it needs
docs, and the docs must land before or with the feature (not after).
Spec Lifecycle Rules
====================
#. Land quickly: A spec is a living document, and lives in the repository
not in gerrit. Potential users, ops and developers will look at
http://specs.openstack.org/openstack/swift-specs/ to get an idea of what's
being worked on, so they need to be quick to land.
#. Initial version is an idea not a technical design: That way the merits of
the idea can be discussed and landed and not stuck in gerrit limbo land.
#. Second version is an overview of the technical design: This will aid in the
technical discussions amongst the community.
#. Subsequent versions improve/enhance technical design: Each of these
versions should be relatively small patches to the spec to keep rule #1. And
keeps the spec up to date with the progress of the implementation.
How to ask questions and get clarifications about a spec
========================================================
Naturally you'll want clarifications about the way a spec is written. To ask