NCAR / ucomp-pipeline

Data processing pipeline for UCoMP
Other
6 stars 3 forks source link

Record decisions via Architecture Decision Records (ADRs) as GitHub issues #303

Open mgalloy opened 1 month ago

mgalloy commented 1 month ago

Context and Problem Statement

We often forget why we made some decision in the pipeline. When circumstances change, we are not sure if we are forgetting other factors in our original decision.

Considered Options

  1. Record our decisions via ADRs as GitHub issues
  2. Record our decisions in some other manner
  3. Don't record our decisions

Decision Outcome

Proposed decisions will be submitted via GitHub issues with the "decision" tag. The status will originally be "proposed" and after discussion will be moved to "accepted" or "rejected". Discussion will happen in the comments, as needed. Discussion from meetings must be captured in the issue for the record.

Issues can then be revisited later, keeping its "accepted" status or changing to "deprecated" or even "superseded by ISSUE", where ISSUE would be a link to a new decision issue.

Consequences

Record our decisions via ADRs as GitHub issues

Pros

Cons

Record our decisions in some other manner

Pros

Cons

Don't record our decisions

Pros

Cons

More Information