This git repository is used to hold approved design specifications for additions to the Packetary 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:
You can find an example spec in doc/source/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 blueprint for a given release can be found by looking at the blueprint in launchpad. Not all approved blueprints 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.
Please note, Launchpad blueprints are still used for tracking the current status of blueprints. For more information, see:
For more information about working with gerrit, see:
To validate that the specification is syntactically correct (i.e. get more confidence in the Jenkins result), please execute the following command:
tox, the documentation will be available for viewing in HTML format in the