Merge pull request #6 from ExcelsiorFamily/define-label-guidelines

Define guidelines for labels management

Author: damienfraud

README.md

@@ -97,8 +97,99 @@ Templates should promote a high contribution quality by referring [contributing
 
 ## Label
 
+Labels should help contributors and reviewers to evaluate effort for a specific issue or pull request.
+
+### Immutablity
+
+GitHub labels should define immutable informations about issues, in order to avoid non-updated scenarios. States should be defined in project section.
+
+**Preferred:**
+```markdown
+- Type: Feature
+- Severity: Low
+```
+
+**Not Preferred:**
+```markdown
+- WorkInProgress
+- Critical
+```
+
+### Colors
+
+Colors should help contributors and reviewers to quickly and visually identify the effort to be done. It is better to use similar color styling accross categories for a consistent and stronger visual identification. Colors should be variants of Red-Orange-Green to provide a sense of priority. Red being the ones that require the most attention. Green being the ones that require little attention.
+
+**Preferred:**
+
+- ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+) `Severity: Low`
+- ![#00cc41](https://placehold.it/15/00cc41/000000?text=+) `Severity: Medium`
+- ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+) `Change: Minor`
+- ![#00cc41](https://placehold.it/15/00cc41/000000?text=+) `Change: Medium`
+
+**Not Preferred:**
+
+- ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+) `Severity: Low`
+- ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+) `Severity: Medium`
+- ![#00cc41](https://placehold.it/15/00cc41/000000?text=+) `Change: Minor`
+- ![#00cc41](https://placehold.it/15/00cc41/000000?text=+) `Change: Medium`
+
+### Categories
+
+Labels should be regrouped into categories to provide consistent information about every issue. Issues cannot have more than one label from the same category.
+
+**Preferred:**
+```markdown
+- Type: Documentation
+- Severity: Medium
+- Change: Minor
+```
+
+**Not Preferred:**
+```markdown
+- Question
+- Feature
+- Documentation
+```
+
+*Pro tip:* GitHub orders labels aphabetically, so following this format allows to keep categories dislayed in the same order accross every issues.
+
+#### Type
+
+Type labels should be used to define the type of task done inside the issue:
+
+- ![#00cc41](https://placehold.it/15/00cc41/000000?text=+) (**#00cc41**) `Type: Feature`: The issue is the development of a new feature of your project
+- ![#ff0000](https://placehold.it/15/ff0000/000000?text=+) (**#ff0000**) `Type: Bug`: The issue is an identified bug that needs to be fixed
+- ![#ffe700](https://placehold.it/15/ffe700/000000?text=+) (**#ffe700**) `Type: Enhancement`: The issue is a suggestion of enhancement to your project
+- ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+) (**#c3b2ef**) `Type: Documentation`: The issue is the creation or refinement of a document.
+
+#### Severity
+
+Severity labels are mostly used for bug-related issues. It allows to identify the critical aspects of the work implied inside the issue:
+
+- ![#000000](https://placehold.it/15/000000/000000?text=+) (**#000000**) `Severity: Blocker`: The issue is blocking an impending release
+- ![#ff4000](https://placehold.it/15/ff4000/000000?text=+) (**#ff4000**) `Severity: Critical`: The issue causes data loss, crashes or hangs salt processes, makes the system unresponsive, etc
+- ![#ff8100](https://placehold.it/15/ff8100/000000?text=+) (**#ff8100**) `Severity: High`: The issue reports incorrect functionality, bad functionality, a confusing user experience, etc
+- ![#ffe700](https://placehold.it/15/ffe700/000000?text=+) (**#ffe700**) `Severity: Strong`: The issue concerns changes to the core areas of the project
+- ![#00cc41](https://placehold.it/15/00cc41/000000?text=+) (**#00cc41**) `Severity: Medium`: The issue reports cosmetic items, formatting, spelling, colors, etc
+- ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+) (**#c3b2ef**) `Severity: Low`: The issue concerns a new feature or any addition to the project.
+
+#### Type of change
+
+Type of change labels are only used for pull requests. They give information about the effort needed to review a pull request:
+
+- ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+) (**#c3b2ef**) `Change: Minor`: Less than 64 lines changed, or less than 8 core lines changed
+- ![#00cc41](https://placehold.it/15/00cc41/000000?text=+) (**#00cc41**) `Change: Medium`: Less than 256 lines changed, or less than 64 core lines changed
+- ![#ffe700](https://placehold.it/15/ffe700/000000?text=+) (**#ffe700**) `Change: Master`: More than 256 lines changed, or more than 64 core lines changed
+- ![#ff0000](https://placehold.it/15/ff0000/000000?text=+) (**#ff0000**) `Change: Expert`: Needs specialized, in-depth review.
+
+*Pro Tip*: We strongly recommend to define core areas to help define the estimated effort.
+
 ## CHANGELOG
 
 ## CONTRIBUTING.md
 
 ## Resources
+
+- [The Official raywenderlich.com Swift Style Guide](https://github.com/raywenderlich/swift-style-guide/blob/master/README.markdown).
+- [Sane GitHub Labels](https://medium.com/@dave_lunny/sane-github-labels-c5d2e6004b63).
+- [GitHub Labels and Milestones](https://docs.saltstack.com/en/2017.7/topics/development/labels.html).