Make use of the common adr template in the .github repo #1599
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…epo and create a new adr
MSevey
requested review from
liamsi,
adlerjohn,
evan-forbes and
rootulp
as code owners
liamsi
previously approved these changes
Apr 5, 2023
rootulp
previously approved these changes
Apr 5, 2023
There was a problem hiding this comment.
[non-blocking] I noticed that make adr-gen without any arguments copy + pastes the template into to docs/architecture/adr--.md because the make command assumes those variables to be defined. It would be nice (although totally optional) if the filename was docs/architecutre/adr-template.md if the arguments weren't specified.
evan-forbes
previously approved these changes
Apr 6, 2023
Co-authored-by: Rootul P <rootulp@gmail.com>
evan-forbes
dismissed stale reviews from rootulp, liamsi, and themself
via
1d4103a
Co-authored-by: Rootul P <rootulp@gmail.com>
evan-forbes
approved these changes
Apr 17, 2023
rootulp
approved these changes
Apr 17, 2023
rootulp
added a commit
that referenced
this pull request
Apr 17, 2023
Addresses #1599 (review) ## Testing ```shell $ make adr-gen $ git status On branch rp/adr-gen Your branch is up to date with 'origin/rp/adr-gen'. Untracked files: (use "git add <file>..." to include in what will be committed) docs/architecture/adr-template.md ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
To unify the ADR structure we added a template in the .github repo. This PR adds a helpful command to generate new ADRs from that template.
Example: https://asciinema.org/a/56X6g1bA9NpWq0FxW8wDMRJ3g
Closes #1415
Checklist