This changeset updates our Architecture Decision Log (ADL) with ADR 0004: Designing Pilot Content Visibility
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
* Fix ADR issue template
This changeset fixes an issue with the ADR issue template: names must be unique!
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This changeset fixes a few lingering typos and incorrect information in the ADRs and updates them with some final decisions. It also fixes an issue with the ADR creation form for GitHub.
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This changeset fixes the formatting of the Architecture Decision Log table; it was missing a cell in the header row.
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
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 changeset reformats our Architecture Decision Log for Architecture Decision Records so a bit more information is displayed. Now, instead of a list, they are in a table with the following details:
- ADR number
- Title
- Current Status
- Date Last Modified
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This changeset adds two new ADRs:
- ADR-0002: Determine How to Handle Timezones in US Notify
- ADR-0003: Implementing Invite Expirations
It also includes a config.yml file for GitHub that was missing in a previous PR to enable the new ADR issue template and form.
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This changeset adds a custom issue template and form for use within GitHub itself to help draft new Architectural Decision Records (ADRs).
Note that we'll still ultimately have to create the actual ADR as a Markdown file that lives in the `doc/adrs/` folder.
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This changeset introduces Architectural Decision Records (ADRs) to the US Notify project. This initial commit includes the following:
- Updates to the main project README.md that mentions ADRs
- A new adr/ folder under the docs/ folder
- An ADR template to copy and follow for the future
- Our first ADR, ADR-0001 - Establishing ADRs
- A README.md specific to ADRs that has more information and instructions
- ADR-0001 finalized and accepted
A huge thank you to @stvnrlly for the help in making this come together!
Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
Co-authored-by: Steven Reilly <stvnrlly@users.noreply.github.com>
