openstack
/
governance
Code Issues Proposed changes

Add template for project taxonomy tags definition 

A template for proposing new tags in the project taxonomy. See next
change in the patchseries for a practical example.

Change-Id: If843e0166583aa9709c19ef4825f3a851a20ede4
This commit is contained in:
Thierry Carrez 2015-01-08 10:37:30 +01:00
parent 19c9d56e69
commit 52e235491c
2 changed files with 81 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
reference/index.rst
View File

@ -6,9 +6,9 @@ Reference documents which need to be revised over time.
.. toctree::
:maxdepth: 2
:glob:
charter
new-programs-requirements
incubation-integration-requirements
project-testing-interface
Template for new tags <tag-template>

80
reference/tag-template.rst Normal file
View File

@ -0,0 +1,80 @@
::
This work is licensed under a Creative Commons Attribution 3.0
Unported License.
http://creativecommons.org/licenses/by/3.0/legalcode
..
This template should be in ReSTructured text. Please do not delete
any of the sections in this template. If you have nothing to say
for a whole section, just write: "None". For help with syntax, see
http://sphinx-doc.org/rest.html To test out your formatting, see
http://www.tele3.cz/jbar/rest/rest.html
========================================================================
proposed-tag-name (should match the tags/proposed-tag-name.rst filename)
========================================================================
..
Tag names can contain a prefix that represents the category of tag.
Category prefixes should end in a colon (:). Category prefixes as
well as tag names should follow a lowercased-hyphen-separated
style. Examples: 'release:coordinated' or 'docs:api-reference-complete'
Introduction paragraph -- a short summary of what this tag will mean.
Rationale
=========
The detailed reason why the OpenStack ecosystem benefits from having this tag
defined.
Requirements
============
* A list of requirements for granting the tag to an existing project.
* All the criteria should be objective and predictable.
* If a tag requires another tag, this should be mentioned here.
Tag application process
=======================
Details of the process to follow to maintain the tag. Are additions/removals
regularly reviewed, or are they considered only upon request ? Which group
is involved, and at which frequency ?
The process may include requiring feedback from specific groups, delegation
of tag maintenance from the TC, minimum delays between application and tag
grant, timeframes where granting or removing the tag is appropriate, etc.
If the grant process is different from the removal process, this should also
be mentioned here.
By default, you can use the following process:
Anyone may propose adding or removing this tag to a set of projects by
proposing a change to the openstack/governance repository. The change is
reviewed by the Technical Committee and approved using standard resolution
approval rules, including discussion at at least one Technical Committee
public IRC meeting.
Deprecation
===========
Some tags may have a deprecation period (where a project retains the tag but
only until a certain announced date). If the proposed tag has a deprecation
period, its duration (and any other specific rules) should be listed here.
Application to current projects
===============================
As part of the application you need to go through the exercise of applying
the proposed tag to at least some subset of the current project list. This
will serve as an example of how the tag should be applied in the real world.
You may also submit (as a subsequent change) the corresponding governance
change to immediately apply the proposed tag to projects.