5177431755
Add specs folder, the readme with flow instructions and a spec example into refstack-client in order to track proposed and implemented changes. Change-Id: I3ec0b4b03f641d461021dc8dbbf6124aa0bd585b
1.9 KiB
| Refstack-Client Specifications |
This folder is used to hold design specifications for additions to the refstack-client 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 folder is as follows:
specs/<release>/
specs/<release>/approved
specs/<release>/implementedThe lifecycle of a specification
Specifications are proposed by adding an .rst file to the
specs/<release>/approved directory and posting it for
review. You can find an example specification in
/specs/template.rst.
Once a specification has been fully implemented, meaning a patch has
landed, it will be moved to the implemented directory and
the corresponding blueprint will be marked as complete.
Specifications are only approved for a single release. If a specification was previously approved but not implemented (or not completely implemented), then the specification needs to be re-proposed by copying (not move) it to the right directory for the current release.
Previously approved specifications
The refstack-client specs directory was created during the Newton
cycle. Therefore, the specs approved and implemented prior to the Newton
cycle will be saved in the RefStack project.
Others
Please note, Launchpad blueprints are still used for tracking the status of the blueprints. For more information, see:
https://wiki.openstack.org/wiki/Blueprints
https://blueprints.launchpad.net/refstackFor more information about working with gerrit, see:
http://docs.openstack.org/infra/manual/developers.html#development-workflowTo validate that the specification is syntactically correct (i.e. get more confidence in the Jenkins result), please execute the following command:
$ tox -e docs