diff options
| -rw-r--r-- | CONTRIBUTING.md | 34 |
1 files changed, 13 insertions, 21 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4f5d19ce2ce..ff92d956e93 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,8 +31,8 @@ _This notice should stay as the first item in the CONTRIBUTING.md file._ - [Subject labels (~wiki, ~"container registry", ~ldap, ~api, etc.)](#subject-labels-wiki-container-registry-ldap-api-etc) - [Team labels (~"CI/CD", ~Discussion, ~Quality, ~Platform, etc.)](#team-labels-cicd-discussion-quality-platform-etc) - [Milestone labels (~Deliverable, ~Stretch, ~"Next Patch Release")](#milestone-labels-deliverable-stretch-next-patch-release) - - [Priority labels (~Deliverable, ~Stretch, ~"Next Patch Release")](#bug-priority-labels-p1-p2-p3-etc) - - [Severity labels (~Deliverable, ~Stretch, ~"Next Patch Release")](#bug-severity-labels-s1-s2-s3-etc) + - [Priority labels (~P1, ~P2, ~P3 , ~P4)](#bug-priority-labels-p1-p2-p3-p4) + - [Severity labels (~S1, ~S2, ~S3 , ~S4)](#bug-severity-labels-s1-s2-s3-s4) - [Label for community contributors (~"Accepting Merge Requests")](#label-for-community-contributors-accepting-merge-requests) - [Implement design & UI elements](#implement-design--ui-elements) - [Issue tracker](#issue-tracker) @@ -211,9 +211,10 @@ Each issue scheduled for the current milestone should be labeled ~Deliverable or ~"Stretch". Any open issue for a previous milestone should be labeled ~"Next Patch Release", or otherwise rescheduled to a different milestone. -### Bug Priority labels (~P1, ~P2, ~P3 & etc.) +### Bug Priority labels (~P1, ~P2, ~P3, ~P4) -Bug Priority labels help us define the time a ~bug fix should be completed. Priority determines how quickly the defect turnaround time must be. If there are multiple defects, the priority decides which defect has to be fixed immediately versus later. +Bug Priority labels help us define the time a ~bug fix should be completed. Priority determines how quickly the defect turnaround time must be. +If there are multiple defects, the priority decides which defect has to be fixed immediately versus later. This label documents the planned timeline & urgency which is used to measure against our actual SLA on delivering ~bug fixes. | Label | Meaning | Estimate time to fix | Guidance | @@ -223,16 +224,7 @@ This label documents the planned timeline & urgency which is used to measure aga | ~P3 | Medium Priority | Within the next 3 releases (approx one quarter) | | | ~P4 | Low Priority | Anything outside the next 3 releases (approx beyond one quarter) | The issue is prominent but does not impact user workflow and a workaround is documented | -#### Specific Priority guidance - -| Label | Availability / Performance | -|-------|--------------------------------------------------------------| -| ~P1 | | -| ~P2 | The issue is (almost) guaranteed to occur in the near future | -| ~P3 | The issue is likely to occur in the near future | -| ~P4 | The issue _may_ occur but it's not likely | - -### Bug Severity labels (~S1, ~S2, ~S3 & etc.) +### Bug Severity labels (~S1, ~S2, ~S3, ~S4) Severity labels help us clearly communicate the impact of a ~bug on users. @@ -243,14 +235,14 @@ Severity labels help us clearly communicate the impact of a ~bug on users. | ~S3 | Major Severity | Broken Feature, workaround acceptable | Can create merge requests only from the Merge Requests page, not through the Issue. | | ~S4 | Low Severity | Functionality inconvenience or cosmetic issue | Label colors are incorrect / not being displayed. | -#### Specific Severity guidance +#### Severity impact guidance -| Label | Security Impact | -|-------|-------------------------------------------------------------------| -| ~S1 | >50% customers impacted (possible company extinction level event) | -| ~S2 | Multiple customers impacted (but not apocalyptic) | -| ~S3 | A single customer impacted | -| ~S4 | No customer impact, or expected impact within 30 days | +| Label | Security Impact | Availability / Performance Impact | +|-------|---------------------------------------------------------------------|--------------------------------------------------------------| +| ~S1 | >50% users impacted (possible company extinction level event) | | +| ~S2 | Many users or multiple paid customers impacted (but not apocalyptic)| The issue is (almost) guaranteed to occur in the near future | +| ~S3 | A few users or a single paid customer impacted | The issue is likely to occur in the near future | +| ~S4 | No paid users/customer impacted, or expected impact within 30 days | The issue _may_ occur but it's not likely | ### Label for community contributors (~"Accepting Merge Requests") |