Skip to content

Commit d6e32f1

Browse files
committed
📝 Add label format specification.
1 parent 14902d4 commit d6e32f1

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,18 @@ Labels should be regrouped into categories. Only three of them are needed.
123123
*Why*
124124
>Categories help identify what label to assign to an issue. Each issue cannot have more than one label from the same category.
125125
126+
Labels should have the following format `Category: Name`.
127+
128+
*Why*
129+
>Having this format allows to be explicit about the category of the label. Also, GitHub orders labels aphabetically, so following this format allows to keep categories dislayed in the same order accross every issues.
130+
131+
**Preferred:**
132+
`Type: Bug`
133+
134+
**Not Preferred:**
135+
`Bug`
136+
137+
126138
Every issue should have a `Type` and a `Severity` label.
127139

128140
*Why*

0 commit comments

Comments
 (0)