89 lines
3.9 KiB
ReStructuredText
89 lines
3.9 KiB
ReStructuredText
Blueprints and Specs
|
|
====================
|
|
|
|
The Glance team uses the `glance-specs
|
|
<http://git.openstack.org/cgit/openstack/glance-specs>`_ repository for its
|
|
specification reviews. Detailed information can be found `here
|
|
<https://wiki.openstack.org/wiki/Blueprints#Glance>`_. Please also find
|
|
additional information in the reviews.rst file.
|
|
|
|
The Glance team enforces a deadline for specs proposals. It's a soft
|
|
freeze that happens after the first milestone is cut and before the
|
|
second milestone is out. There's a freeze exception week that follows
|
|
the freeze week. A new proposal can still be submitted during this
|
|
period, but be aware that it will most likely be postponed unless a
|
|
particularly good argument is made in favor of having an exception for
|
|
it.
|
|
|
|
Please note that we use a `template
|
|
<http://git.openstack.org/cgit/openstack/glance-specs/tree/specs/template.rst>`_
|
|
for spec submissions. It is not required to fill out all sections in the
|
|
template. Review of the spec may require filling in information left out by
|
|
the submitter.
|
|
|
|
Spec Notes
|
|
----------
|
|
|
|
There are occasions when a spec will be approved and the code will not land in
|
|
the cycle it was targeted at. For these cases, the work flow to get the spec
|
|
into the next release is as follows:
|
|
|
|
* Anyone can propose a patch to glance-specs which moves a spec from the
|
|
previous release into the new release directory.
|
|
|
|
.. NOTE: mention the `approved`, `implemented` dirs
|
|
|
|
The specs which are moved in this way can be fast-tracked into the
|
|
next release. Please note that it is required to re-propose the spec
|
|
for the new release however and that it'll be evaluated based on the
|
|
resources available and cycle priorities.
|
|
|
|
Glance Spec Lite
|
|
----------------
|
|
|
|
In Mitaka the team introduced the concept of lite specs. Lite specs
|
|
are small features tracked as Launchpad bugs, with status `wishlist`
|
|
and tagged with the new 'spec-lite' tag, and allow for the submission
|
|
and review of these feature requests before code is submitted.
|
|
|
|
This allows for small features that don't warrant a detailed spec to
|
|
be proposed, evaluated, and worked on. The team evaluates these
|
|
requests as it evaluates specs. Once a bug has been approved as a
|
|
Request for Enhancement (RFE), it'll be targeted for a release.
|
|
|
|
In Newton the team refined lite specs process away from wishlist bugs
|
|
and lite specs are hosted in the glance-specs repository in git.
|
|
|
|
Dedicated lite-specs.rst is provided for each deliverable under the
|
|
release.
|
|
|
|
For example Newton glance_store spec lite file can be found from:
|
|
glance-specs/specs/newton/approved/glance_store/lite-specs.rst
|
|
|
|
This file includes template section and new lite-specs should be
|
|
included to the same file under the template. So do not copy the lite-
|
|
specs.rst to a new file like you would do with full spec, but just
|
|
propose change to that file itself filling the parts of the template
|
|
you need.
|
|
|
|
Existing WISHLIST 'spec-lite' tagged bug will be honored as lite spec,
|
|
new ones will not be considered unless filed in glance-spec repo.
|
|
|
|
|
|
Lite spec Submission Guidelines
|
|
-------------------------------
|
|
|
|
Before we dive into the guidelines for writing a good lite spec, it is
|
|
worth mentioning that depending on your level of engagement with the
|
|
Glance project and your role (user, developer, deployer, operator,
|
|
etc.), you are more than welcome to have a preliminary discussion of a
|
|
potential lite spec by reaching out to other people involved in the
|
|
project. This usually happens by posting mails on the relevant mailing
|
|
lists (e.g. `openstack-dev <http://lists.openstack.org>`_ - include
|
|
[glance] in the subject) or on #openstack-glance IRC channel on
|
|
Freenode. If current ongoing code reviews are related to your feature,
|
|
posting comments/questions on gerrit may also be a way to engage. Some
|
|
amount of interaction with Glance developers will give you an idea of
|
|
the plausibility and form of your lite spec before you submit it. That
|
|
said, this is not mandatory.
|