Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Labels guidelines. #14

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,15 +247,15 @@ Colors should help contributors and reviewers to quickly and visually identify t

**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`
- ![#00cc41](https://placehold.it/15/00cc41/000000?text=+) `Severity: Low`
- ![#ffe700](https://placehold.it/15/ffe700/000000?text=+) `Severity: Medium`
- ![#00cc41](https://placehold.it/15/00cc41/000000?text=+) `Change: Minor`
- ![#ffe700](https://placehold.it/15/ffe700/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`
- ![#ffe700](https://placehold.it/15/ffe700/000000?text=+) `Severity: Low`
- ![#ffe700](https://placehold.it/15/ffe700/000000?text=+) `Severity: Medium`
- ![#00cc41](https://placehold.it/15/00cc41/000000?text=+) `Change: Minor`
- ![#00cc41](https://placehold.it/15/00cc41/000000?text=+) `Change: Medium`

Expand Down Expand Up @@ -283,30 +283,30 @@ Labels should be regrouped into categories to provide consistent information abo

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
- ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+) (**#c3b2ef**) `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.
- ![#00cc41](https://placehold.it/15/00cc41/000000?text=+) (**#00cc41**) `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.
- ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+) (**#c3b2ef**) `Severity: Critical`: The issue causes data loss, crashes or hangs salt processes, makes the system unresponsive, etc
- ![#ff0000](https://placehold.it/15/ff0000/000000?text=+) (**#ff0000**) `Severity: High`: The issue reports incorrect functionality, bad functionality, a confusing user experience, etc
- ![#ff8100](https://placehold.it/15/ff8100/000000?text=+) (**#ff8100**) `Severity: Strong`: The issue concerns changes to the core areas of the project
- ![#ffe700](https://placehold.it/15/ffe700/000000?text=+) (**#ffe700**) `Severity: Medium`: The issue reports cosmetic items, formatting, spelling, colors, etc
- ![#00cc41](https://placehold.it/15/00cc41/000000?text=+) (**#00cc41**) `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.
- ![#00cc41](https://placehold.it/15/c3b2ef/000000?text=+) (**#00cc41**) `Change: Minor`: Less than 64 lines changed, or less than 8 core lines changed
- ![#ffe700](https://placehold.it/15/ffe700/000000?text=+) (**#ffe700**) `Change: Medium`: Less than 256 lines changed, or less than 64 core lines changed
- ![#ff0000](https://placehold.it/15/ff0000/000000?text=+) (**#ff0000**) `Change: Master`: More than 256 lines changed, or more than 64 core lines changed
- ![#c3b2ef](https://placehold.it/15/c3b2ef/000000?text=+) (**#c3b2ef**) `Change: Expert`: Needs specialized, in-depth review.

*Pro Tip*: We strongly recommend to define core areas to help define the estimated effort.

Expand Down