Tags and Prefixes
Contents
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
To help us all keep things straight and to enable us to share queries and searches please follow these rules:
- All newly created Stories shall be tagged as described here
- All newly newly created Stories shall be tagged with stx.new so we know that the story needs to be reviewed and assigned to a release.
Tags for Story "kinds"
Tag | Description |
---|---|
stx.bug | For defects |
stx.new | For a brand new Story that needs to be assigned to a Sub-project and/or a release |
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
This page is under construction.
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
Prefix | Description |
---|---|
[Bug] | A problem which impairs or prevents the functionality of StarlingX |
[Feature] | For new features and enhancements |
[TBD] | For TBD |
Examples
A new defect for the Security Sub-project that should be fixed in the stx.2018.11 release would be tagged as: stx.bug, stx.2018.11, stx.security. The description can optionally contain "[BUG][Security]".
A new feature for the TBD Sub-project should be tagged as: stx.feature stx.TBD. The description can optionally contain [Feature][TBD].