mirror of
https://github.com/GSA/notifications-api.git
synced 2025-12-10 07:12:20 -05:00
Update ADR details
This changeset updates our ADR documentation to include notes on draft and private ADRs that need to live outside of GitHub. It updates the README with this information and also introduces an "implemented" flag in addition to the ADR status itself. This is reflected in the ADR templates. Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This commit is contained in:
4
.github/ISSUE_TEMPLATE/create-a-new-adr.md
vendored
4
.github/ISSUE_TEMPLATE/create-a-new-adr.md
vendored
@@ -10,9 +10,9 @@ assignees: ''
|
||||
# TITLE: ADR Title Here
|
||||
|
||||
|
||||
| CREATED DATE | LAST UPDATED | STATUS | AUTHOR | STAKEHOLDERS |
|
||||
| CREATED DATE | LAST UPDATED | STATUS | IMPLEMENTED | AUTHOR | STAKEHOLDERS |
|
||||
| :---: | :---: | :---: | :---: | :---: |
|
||||
| Date when ADR was created - MM/DD/YYYY format | Date when ADR was last updated - MM/DD/YYYY format - or N/A | Current ADR status - one of Proposed / Accepted / Rejected / Deprecated / Superseded By ADR - link to ADR | GitHub username(s) of author(s) | GitHub username(s) or team name(s) of other folks involved |
|
||||
| Date when ADR was created - MM/DD/YYYY format | Date when ADR was last updated - MM/DD/YYYY format - or N/A | Current ADR status - one of Proposed / Accepted / Rejected / Deprecated / Superseded By ADR - link to ADR | Yes or No | GitHub username(s) of author(s) | GitHub username(s) or team name(s) of other folks involved |
|
||||
|
||||
|
||||
## CONTEXT AND PROBLEM STATEMENT
|
||||
|
||||
10
.github/ISSUE_TEMPLATE/create-new-adr-form.yml
vendored
10
.github/ISSUE_TEMPLATE/create-new-adr-form.yml
vendored
@@ -36,6 +36,16 @@ body:
|
||||
- Superseded By
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: implemented
|
||||
attributes:
|
||||
label: Implemented
|
||||
description: Is this ADR implemented?
|
||||
options:
|
||||
- Yes
|
||||
- No
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: superseded_by
|
||||
attributes:
|
||||
|
||||
Reference in New Issue
Block a user