DR: Issue priority and merge request labeling guide

Introduction

Today, during issues reviewing process in the daily dev call, we do not have a clear guideline on prioritizing issues to be fixed. We mainly rely on issue reporters to come up with a fix/merge request(MR). In cases where issues are reported without any fix/MR, depending on the urgency/impact, these issues still need to be addressed with the appropriate attention.

Similarly, we need to have clear labeling to understand the issue/MR reported.

This is an extension of the current PMC Issue Taxonomy

Objective

Here is a proposal for the community to prioritize and categorize issues and MRs that are being reported. The labels will be used to use to indicate the state of the issues and merge requests.

Issue labels

Issue Type

Category	Label	Description
Under review	IssueUnder Review	This issue is currently under review, needs more information from the submitter and/or needs to be confirmed if it is the intended behavior of the service. Once confirmed, it could be a Defect, Backlog, ADR or DR.
Defect	IssueDefect	A Defect is an issue that is a software error, flaw or fault that causes that project or repo or service to produce an incorrect or unexpected result per the OSDU standard or requirements or that it behaves in unintended ways. A defect can be further categorized as a defect in the common code in the PMC project or as a defect within the CSP realization of the PMC project to ensure that it can be targeted towards the right development resource to address this issue.
Feature	IssueFeature Request	A Feature is an issue that is either a new requirement that needs software enhancement, new feature development (perhaps requiring new repos, sub-projects or new PMC projects). These need to follow a template (see below) that provides enough clarity on the requirement, the definition of done and other necessary attributes so the issue can be curated and moved up in life cycle. Requires an entry in Aha portal.
Non Issue	IssueNon Issue	A Non Issue is an issue that is not necessarily a defect or backlog, could be used by developers as a task to track the ongoing activity, clean-ups
Architecture Decision Record - ADR	~"Issue::Architecture/Technology"	A architecture decision (ADR)is a result of an issue backlog, defect or a new OSDU standard that has triggered the need for a new design (perhaps requiring new technology selections, architecture patterns)
Decision Record on a process - DR	IssueProcess Decision	A decision record (DR) is a result of a process shortcomings where a new OSDU practice has been triggered to address the existing process shortcomings (perhaps requiring new process, operation patterns)

Issue should be flagged along milestone

Label	Description
M12	Milestone where issue is discovered

Issue labels show the state of the issues and should be used alongside priority labels to indicate the urgency of the issue and prioritize resources to address the issue.

Issue life-cycle

Category	Label	Description
Backlog	KBBacklog	Label applied to indicate that issues are confirmed, but no active work are in progress. Pending volunteers. Label should be used alongside Confirmed issue.
Fix in progress	KBIn Progress	Label applied to indicate that issues are confirmed and fixes are in progress. Label should be used alongside Confirmed issue.
Done	KBDone	Label applied to indicate that issues are confirmed and fixes are done. Issues can be closed. Label should be used alongside Confirmed issue.

Affected responsibility

Category	Label	Description
Confirmed issue	Common Code AWS Azure ~"GCP" IBM	Label applied to identify issue that has been confirmed and is affecting for all CSPs (common), Azure, IBM , GCP or AWS.

Priority labels

Priority label needs to be assigned along to issue label to indicate the urgency. Developers/volunteers should work on issues according to the agreed priority label.

Label	Description
PriorityCritical	Catastrophic issue identified - Severe impact, contain breaking workflow/data loss, zero-day/critical security vulnerabilities No workaround and should be fixed as an immediate priority Need to be released as a patch during regular milestone cycle as soon as a fix is available
PriorityHigh	Major issue identified - High impact, might contain breaking workflow/data loss, critical/high security vulnerabilities There is a workaround that exists but should be fixed as the next priority Might need to be released as a patch during regular milestone cycle/N+1 milestone release
PriorityMedium	Serious issue identified - Medium impact, no breaking workflow/no data loss, high/medium security vulnerabilities There is a workaround that exists and should be fixed after high priority Can be released in N+1 milestone release
PriorityLow	Minor issue identified - Low impact, no breaking workflow/any workflow, medium/low security vulnerabilities There is a workaround that exists Can be released in N+1 or more milestone releases

Use cases

Issue

Label	Description
IssueDefect KBDone Common Code	A labeling strategy for defect that has been resolved after related MR(s) are merged

Merge request

Label	Description
MRBugfix Common Code	A labeling strategy for defect that has been resolved after related MR(s) are merged