search

joelparkerhenderson / architecture-decision-record

Architecture decision record (ADR) examples for software planning, IT leadership, and template documentation
Other
12.01k stars 2.43k forks source link

Improved links to MADR, added one template #62

Closed socadk closed 1 year ago

joelparkerhenderson commented 1 year ago

Thanks! I see the PR has a different things mixed together.

For the new info, that's good. Would you like to do a PR for just that, so you get credit for it? Or if you prefer I can just add it on my side.

For the MADR-related items, those aren't OK as is. MADR is the author's abbreviation, and the related tool name is "madr", and the GitHub link uses "madr". This repo's links and template are using "MADR" in order to match the author's abbreviation.

The author and I have been in touch for many years, and MADR is what the MADR author requested of me. If the author wants a change, I'll of course do it.

socadk commented 1 year ago

Thanks for the feedback to both of you, I have changed the patch-1 branch accordingly. I can also create a new separate PR if that helps.

The README also has a section "Suggestions for writing good ADRs", I recently wrote on this topic here: https://ozimmer.ch/practices/2023/04/03/ADRCreation.html (just FYI, comments welcome).

joelparkerhenderson commented 1 year ago

Good thanks!