theupdateframework / python-tuf

Python reference implementation of The Update Framework (TUF)
https://theupdateframework.com/
Apache License 2.0
1.63k stars 272 forks source link

Keep track of procedural and architectural decision #1141

Closed lukpueh closed 4 years ago

lukpueh commented 4 years ago

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.

aaaaalbert commented 4 years ago

Try Markdown Architectural Decision Records, looks like this could suit your needs.

joshuagl commented 4 years ago

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.