Skip to content

Commit 14902d4

Browse files
committed
📝 Add Immutability and Colors headlines. Remove and from guideline description.
1 parent 4a6f1f2 commit 14902d4

1 file changed

Lines changed: 32 additions & 9 deletions

File tree

README.md

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -95,17 +95,40 @@ Templates should promote a high contribution quality by referring [contributing
9595

9696
## Milestone
9797

98-
## Label
98+
## Labels
9999

100-
We believe GitHub labels should define immutable informations about issues.
100+
### Immutablity
101101

102-
We consider having to change labels over time to be a bad practice. Indeed, changing labels manually multiple times on issues can be very time consumming and prone to errors. Moreover, we believe that if the information about the issue is changing, it is surely not a relevant information to have as a label. Almost everytime, you will see that variable informations about an issue can be managed in another way which will be much more efficient in the end. If you consider this, you will tremendously reduce useless labels creation, and see that you have more than enough information through it.
102+
GitHub labels should define immutable informations about issues.
103103

104-
We believe that labels should be regrouped into categories and that you only need three of them. We also recommend to use similar color styling accross categories for a stronger visual identification.
105-
Here are what we believe to be the best labels to use and what they mean.
106-
We recommend to use the label name, color hex code as they are and use the rest as the description.
104+
*Why*
105+
>Having to change labels over time is a bad practice. Indeed, changing labels manually multiple times on issues can be very time consumming and prone to errors. Moreover, if the information about the issue is changing, it is surely not a relevant information to have as a label. Almost everytime, any variable information about an issue can be managed in another way which will be much more efficient in the end. Considering this will tremendously reduce useless labels creation.
107106
108-
### Type
107+
### Colors
108+
109+
It is better to use similar color styling accross categories for a stronger visual identification.
110+
111+
*Why*
112+
>Keeping same color styling accross categories is key for a strong and clear visual identification.
113+
114+
Colors should be variants of Red-Orange-Green.
115+
116+
*Why*
117+
>Red-Orange-Green variations are commonly used internationally to provide a sense of state. Red being the ones that require the most attention. Green being the ones that require little attention.
118+
119+
### Categories
120+
121+
Labels should be regrouped into categories. Only three of them are needed.
122+
123+
*Why*
124+
>Categories help identify what label to assign to an issue. Each issue cannot have more than one label from the same category.
125+
126+
Every issue should have a `Type` and a `Severity` label.
127+
128+
*Why*
129+
>Having the same labels on every issue helps for visual consistency. Also, these are necessary informations for any issue.
130+
131+
#### Type
109132

110133
Type labels should be used to define the type of task done inside the issue.
111134

@@ -121,7 +144,7 @@ The issue is a suggestion of enhancement to your project.
121144
- `Type: Documentation` **#c3b2ef**
122145
The issue is the creation or refinement of a document.
123146

124-
### Severity
147+
#### Severity
125148

126149
Severity labels are mostly used for bug-related issues. It allows to identify the critical aspects of the work implied inside the issue.
127150

@@ -143,7 +166,7 @@ The issue reports cosmetic items, formatting, spelling, colors, etc.
143166
- `Severity: Low` **#c3b2ef**
144167
The issue concerns a new feature or any addition to the project.
145168

146-
### Type of change
169+
#### Type of change
147170

148171
Type of change labels are only used for pull requests. They give information about the effort needed to review a pull request. We strongly recommend to define core areas to help define the estimated effort.
149172

0 commit comments

Comments
 (0)