-
Notifications
You must be signed in to change notification settings - Fork 273
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.
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
Keep track of procedural and architectural decision #1141
Labels
decision record
Outcome of this discussion should be tracked in a decision record
Milestone
Comments
lukpueh
added
the
decision record
Outcome of this discussion should be tracked in a decision record
label
Sep 10, 2020
Try Markdown Architectural Decision Records, looks like this could suit your needs. |
This was referenced Sep 28, 2020
joshuagl
added a commit
to joshuagl/tuf
that referenced
this issue
Oct 21, 2020
In order to make decisions about the code and the design explicit and easier to reference in future we want to record significant architectural decisions. This commit introduces docs/adr with a template Architectural Decision Record and index using the [MADR](https://adr.github.io/madr/) format. It also adds ADR 0000 to document the decisions to use MADR. Fixes theupdateframework#1141 Signed-off-by: Joshua Lock <jlock@vmware.com>
joshuagl
added a commit
to joshuagl/tuf
that referenced
this issue
Oct 21, 2020
In order to make decisions about the code and the design explicit and easier to reference in future we want to record significant architectural decisions. This commit introduces docs/adr with a template Architectural Decision Record and index using the [MADR](https://adr.github.io/madr/) format. It also adds ADR 0000 to document the decisions to use MADR. Fixes theupdateframework#1141 Signed-off-by: Joshua Lock <jlock@vmware.com>
Thanks for the suggestion @aaaaalbert, MADR does look like a good fit for us. It has enough structure to encourage us to capture the relevant details while remaining relatively lightweight. |
3 tasks
joshuagl
added a commit
to joshuagl/tuf
that referenced
this issue
Oct 26, 2020
In order to make decisions about the code and the design explicit and easier to reference in future we want to record significant architectural decisions. This commit introduces docs/adr with a template Architectural Decision Record and index using the [MADR](https://adr.github.io/madr/) format. It also adds ADR 0000 to document the decisions to use MADR. Fixes theupdateframework#1141 Signed-off-by: Joshua Lock <jlock@vmware.com>
MVrachev
pushed a commit
to MVrachev/tuf
that referenced
this issue
Oct 28, 2020
In order to make decisions about the code and the design explicit and easier to reference in future we want to record significant architectural decisions. This commit introduces docs/adr with a template Architectural Decision Record and index using the [MADR](https://adr.github.io/madr/) format. It also adds ADR 0000 to document the decisions to use MADR. Fixes theupdateframework#1141 Signed-off-by: Joshua Lock <jlock@vmware.com>
MVrachev
pushed a commit
to MVrachev/tuf
that referenced
this issue
Nov 3, 2020
In order to make decisions about the code and the design explicit and easier to reference in future we want to record significant architectural decisions. This commit introduces docs/adr with a template Architectural Decision Record and index using the [MADR](https://adr.github.io/madr/) format. It also adds ADR 0000 to document the decisions to use MADR. Fixes theupdateframework#1141 Signed-off-by: Joshua Lock <jlock@vmware.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
In the course of the imminent TUF refactor we are submitting many discussion issues under an additional decision record label. These discussions are intended to inform both procedural and architectural decision that are worthy of being tracked.
For this purpose we should keep a (low-maintenance) list where we can append decisions as we make them, together with pointers to background discussions and rationale, e.g. in the corresponding issue pages.
@joshuagl suggests (and I agree) to keep the lists in markdown documents as part of the TUF repo, which seem less likely to get abondoned/lost than e.g. external wiki pages or Google docs, and also make collaboration easier.
The text was updated successfully, but these errors were encountered: