Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Issue 145] Update ADR template and process #146

Merged
merged 3 commits into from
Jul 7, 2023
Merged

[Issue 145] Update ADR template and process #146

merged 3 commits into from
Jul 7, 2023

Conversation

widal001
Copy link
Collaborator

@widal001 widal001 commented Jul 7, 2023

Summary

Updates the GitHub issue template for ADRs and outlines ADR process to make it clearer for future architecture decisions.

Fixes #145

Time to review: 3 mins

Changes proposed

What was added, updated, or removed in this PR.

  • Updates ADR issue template:
    • Adds Approver section (to be filled out during sprint planning)
    • Updates acceptance criteria in Definition of Done section
  • Updates README with ADR process
  • Removes the following statuses from template, since ADRs with these statuses wouldn't be merged in:
    • Draft
    • Proposed
    • Rejected

Context for reviewers

Testing instructions, background context, more in-depth details of the implementation, and anything else you'd like to call out or ask reviewers. Explain how the changes were verified.

  • Test out a sample of the new ADR issue template
  • Review the proposed ADR process in documentation/decisions/README.md

Additional information

Screenshots, GIF demos, code examples or output to help show the changes working as expected.

Screenshot 2023-07-07 at 12 48 18 PM Screenshot 2023-07-07 at 12 48 27 PM

widal001 added 3 commits July 7, 2023 12:37
@widal001
refactor(github): Updates ADR issue template
122532e 
- Adds an Approvers section
- Updates the acceptance criteria
@widal001
feat(adr): Outlines process for ADRs
6a7ee57
@widal001
refactor(adr): Updates list of statuses in template
f4f8dd5 
Removes Draft, Proposed, and Rejected status since those won't be merged
daphnegold
daphnegold reviewed Jul 7, 2023
View reviewed changes
.github/ISSUE_TEMPLATE/adr.yml
validations:
required: true
required: true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Woops. I apparently did not have a trailing whitespace extension enabled.

sarahknoppA6
sarahknoppA6 approved these changes Jul 7, 2023
View reviewed changes
Copy link
Collaborator

@sarahknoppA6 sarahknoppA6 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like what we discussed. Thank you for updating this!

@widal001 widal001 merged commit eccf95b into main Jul 7, 2023
@widal001 widal001 deleted the issue-145-update-adr-template branch July 7, 2023 20:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@EOKENAVA EOKENAVA EOKENAVA approved these changes

@sarahknoppA6 sarahknoppA6 sarahknoppA6 approved these changes

@daphnegold daphnegold daphnegold approved these changes

@andycochran andycochran andycochran approved these changes

@acouch acouch Awaiting requested review from acouch acouch is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Task]: Update ADR template and process
5 participants
@widal001 @andycochran @daphnegold @sarahknoppA6 @EOKENAVA