Add README and base directory structure

This commit introduces the proposed layout for this repository.  The
next step after this will be to start defining the expected layout of
a spec and provide some templates.

Change-Id: I4b38d75802f3c7feef98639dfddd1898e564145f
This commit is contained in:
Russell Bryant 2014-03-15 10:57:16 -04:00
parent 394c999c50
commit 26f907c98f
4 changed files with 34 additions and 0 deletions

34
README.rst Normal file
View File

@ -0,0 +1,34 @@
==================================
OpenStack Nova Specifications
==================================
This git repository is used to hold approved design specifications for additions
to the Nova project. Reviews of the specs are done in gerrit, using a similar
workflow to how we review and merge changes to the code itself.
The layout of this repository is::
<release>/
approved/
implemented/
Specifications are proposed for a given release by adding it to the `approved`
directory and posting it for review. Once a given spec has been fully
implemented in a release, it can be moved to the `implemented` directory. This
provides an easy view of what was actually implemented in a given release. What
remains in the `approved` directory will provide historical record of specs we
approved but were not fully implemented.
Specifications have to be re-proposed for every release. The review may be
quick, but even if something was previously approved, it should be re-reviewed
to make sure it still makes sense as written.
Prior to the Juno development cycle, this repository was not used for spec
reviews. Reviews prior to Juno were completed entirely through Launchpad
blueprints::
http://blueprints.launchpad.net/nova
For more information about working with gerrit, see::
https://wiki.openstack.org/wiki/Gerrit_Workflow

0
juno/.gitignore vendored Normal file
View File

0
juno/approved/.gitignore vendored Normal file
View File

0
juno/implemented/.gitignore vendored Normal file
View File