Adding an ADR for GH labels decluttering (issue usnistgov#1496 part 1) (

usnistgov#1680) * added ADR for GH labels * Update decisions/0003-github-labels-decluttering.md Co-authored-by: A.J. Stein <[email protected]> * Adding label fro FAQ Co-authored-by: A.J. Stein <[email protected]> --------- Co-authored-by: A.J. Stein <[email protected]>
mrutkows · Mar 2, 2023 · 60918cd · 60918cd
1 parent f87dcb1
commit 60918cd
Showing 1 changed file with 86 additions and 0 deletions.
diff --git a/decisions/0003-github-labels-decluttering.md b/decisions/0003-github-labels-decluttering.md
@@ -0,0 +1,86 @@
+# Use of Labels in OSCAL Project(s)
+
+Date: 02/17/2023
+
+## Status
+
+Approved
+
+## Context
+
+We wish to improve communication within the team and among the community members. Labels we use in OSCAL repositories can be a part of the effort.  We have discussed a number of options around labels and we will use an ADR to capture and document our approach moving forward.
+
+- Related to Issue [#1496](https://github.com/usnistgov/OSCAL/issues/1496)
+
+## Decision
+
+Existing labels were reviewed, a subset of labels is kept and new ones are defined.
+
+The lists of labels that follow will use across OSCAL repositories.
+
+#### General labels:
+
+- breaking change
+- community feedback needed
+- developer experience
+- discussion needed
+- epic
+- faq
+- rfc
+- scope: ci/cd
+- scope: content
+- scope: documentation
+- scope: metaschema
+- scope: modeling
+- scope: tooling and APIs
+- scope: website
+
+#### Project-specific labels:
+
+- model engineering
+- research
+- profile resolution
+
+#### Default (GH) labels:
+
+- bug
+- duplicate
+- enhancement
+- help wanted
+- invalid
+- question
+- wontfix
+
+#### Technology-identifying labels: Used by the ```dependabot```
+
+- dependencies
+- docker
+- github_actions
+- java
+- javascript
+- go
+- python
+- ruby
+- submodules
+
+
+#### Labels to be sunset/removed
+
+- Lunch with the Devs
+- Model Review 
+
+### Use of Labels on Issues
+
+**Creation of Issues:**
+
+1. When issues are created, labels will be assigned by the author.
+2. When the issue is triaged, selected labels will be reviewed and adjusted as necessary, including the addition of any omitted labels.
+
+**Consistency Across Projects**
+Except for the _Project-specific labels_ all other labels shall be used per their description
+
+
+## Consequences
+
+- Too many labels, or labels that are inconsistently used, will cause confusion.
+- Detail information capturing the spike that researched this ADR is available [here](https://hackmd.io/UrSjUKGiQRuiA2VJLG-Mpg)