---
# System prepended metadata

title: '#1496 How do track and communicate work done'

---

# #1496 How do track and communicate work done

## Draft an ADR for labels 

- Related to Issue [#1496] - (https://github.com/usnistgov/OSCAL/issues/1496)

- Overall notes: https://hackmd.io/YS5ib1yMQ4ab-7Ocyy2vUA


## Begin ADR Draft
---


# Use of Labels in OSCAL Project(s)

Date: 02/16/2023

## Status

Proposed

## Context

We wish to improve communication within the team, and among the community. 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


### Labels to be ADDED/RETAINED

**REVIEW AND MOVE AS NECESSARY**

- [ ] Breaking Change - This will be a breaking change (potentially requiring major version increment).
- [rm] ~~closable~~
- [lc] Developer Experience
- [lc] Discussion Needed
- [lc] Epic
- [ ] ~~LoE: Large~~
- [ ] ~~LoE: Medium~~
- [ ] ~~LoE: Small~~
- [ ] ~~model-refactor~~
- [ ] ~~ongoing effort~~
- [lc] Profile Resolution
- [ ] ~~REST API Standardization~~
- [lc] RFC
- [lc] Scope: CI/CD
- [lc] Scope: Content
- [lc] Scope: Documentation
- [lc] Scope: Metaschema
- [lc] Scope: Modeling
- [lc] ~~Scope: Repository~~
- [lc] Scope: Tooling and APIs
- [lc] Scope: Website
- [ ] ~~User Story~~
- [ ] ~~Waiting for Action~~

**New:**

- model engineering
- blocked

**Retain:**

- [lc] Community Feedback Needed
- [lc] ~~Discovery ~~(research)

Default:

- [ ] bug
- [ ] duplicate
- [ ] enhancement
- [ ] help wanted
- [ ] invalid
- [ ] question
- [ ] wontfix

Technologies: for dependabot

- [ ] dependencies
- [ ] docker
- [ ] github_actions
- [ ] java
- [ ] javascript
- [ ] go
- [ ] python
- [ ] ruby
- [ ] submodules


### Labels to be REMOVED/RETIRED

- 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 addition of any omitted labels.

**Consistency Across Projects**

...

## Consequences

- Too many labels, or labels that are inconsistently used, will cause confusion.
