Difference between revisions of "Tags and Prefixes"

Revision as of 17:56, 20 July 2018

Tags and Prefixes

Tags

Each new Story created shall be marked with Tags. We are using Tags to:

Show what kind of a Story it is - a Bug, a Feature, etc...
Show what release the Story is targeted to: stx.2018.08, stx.2018.11, etc... See the TBD section for more info on our Release plans
Show which sub-project of Starling is responsible for completing the Story. See the TBD section for more info on the project's sub-projects

Tagging new stories is mandatory to enable efficient management of the large number of stories we are creating

Tags for Story "kinds"

Tag	Description
stx.bug	For defects
stx.feature	For new features

Tags for Story Releases

Tag	Description
stx.2018.08	For bugs or features intended to be completed before the August code freeze for the September release
stx.2018.11	For bugs or features intended to be completed before the November code freeze for the December release

Tags for Sub-projects

Tag	Description
stx.security	For bugs or features for the Security sub-project
TBD	For bugs or features for the TBD sub-project

Prefixes

To make it easier to visually identify categories of work and to search on them, you can optionally add a prefix to the description for a Story. The following prefixes are defined:

- [Bug]: A problem which impairs or prevents the functionality of StarlingX
- [Enhancement]: An improvement or enhancement to the functionality of StartingX; typically smaller scope items
- [Feature]: A new feature/functionality to be added to StarlingX. Ideally, the scope should fit within a release time-frame (ex: 3-6 months)
- [Build]: Build tools, environment, repo organization, etc
- [Process]: Process and project related work items
- [Test]: Test/Validation related work items
- [Doc]: Documentation related work items
- [Upstreaming]: Work items that need to be pushed in the core openstack projects or other 3rd party repo's
- [Help]: Request for assistance, questions

@@ Line 2: / Line 2: @@
 === Tags ===
-Each new Story created shall be marked with Tags to:
+Each new Story created shall be marked with Tags.  We are using Tags to:
 * Show what kind of a Story it is - a Bug, a Feature, etc...
 * Show what release the Story is targeted to: stx.2018.08, stx.2018.11, etc...  See the TBD section for more info on our Release plans
 * Show which sub-project of Starling is responsible for completing the Story.  See the TBD section for more info on the project's sub-projects
+<br />
+Tagging new stories is mandatory to enable efficient management of the large number of stories we are creating
+==== Tags for Story "kinds" ====
+{| class="wikitable"
+|-
+! Tag !! Description
+|-
+| stx.bug || For defects
+|-
+| stx.feature || For new features
+|}
+==== Tags for Story Releases ====
+{| class="wikitable"
+|-
+! Tag !! Description
+|-
+| stx.2018.08|| For bugs or features intended to be completed before the August code freeze for the September release
+|-
+| stx.2018.11|| For bugs or features intended to be completed before the November code freeze for the December release
+|}
-Tagging new stories is mandatory.
+==== Tags for Sub-projects ====
+{| class="wikitable"
-Tags for Story kinds currently defined are:
+|-
-* "stx.bug" - for defects
+! Tag !! Description
-* "stx.feature" - for new features
+|-
+| stx.security|| For bugs or features for the Security sub-project
-Tags for Releases currently defined are:
+|-
-* "stx.2018.08" - for bugs or features intended to be completed before the August code freeze for the September release
+| TBD || For bugs or features for the TBD sub-project
-* "stx.2018.11" - for bugs or features intended to be completed before the November code freeze for the December release
+|}
-Tags for Sub-projects currently defined are:
-* "stx.security" - for defects and features for the Security sub-project
-* Additional tags e.g. for the project sub-projects will be defined shortly
 === Prefixes ===