openstack/cloudkitty-specs
Code Issues Proposed changes
ccc71e4f5e
cloudkitty-specs/README.rst
Luka Peschke 9616269ecf Refreshing the repository 
This commit aims at updating this repo, as it is intended to be used much more
from now on.

The README and spec template have been updated in order to remove any
comments or informations about launchpad/blueprints.

Change-Id: Ideaf51be8acf5e39713c8c4fa4d186c76c2ec569
Story: 2004180
Task: 27667
2018-10-25 16:39:58 +02:00

1.3 KiB
Raw Blame History

OpenStack Cloudkitty Specifications

This git repository is used to hold approved design specifications for additions to the Cloudkitty 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:

specs/<release>/

You can find an example spec in specs/template.rst.

Specifications are proposed for a given release by adding them to the specs/<release> directory and posting it for review. The implementation status of a story for a given release can be found by looking at the story in Storyboard. Not all stories will get 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.

For more information about working with gerrit, see:

http://docs.openstack.org/infra/manual/developers.html#development-workflow

To validate that the specification is syntactically correct (i.e. get more confidence in the Jenkins result), please execute the following command:

$ tox

After running tox, the documentation will be available for viewing in HTML format in the doc/build/ directory.