search

npryce / adr-tools

Command-line tools for working with Architecture Decision Records
Other
4.63k stars 588 forks source link

Add MADR support #43

Closed snisnisniksonah closed 6 years ago

snisnisniksonah commented 6 years ago

This PR adds dedicated support for the Markdown Archicturual Decision Records by @koppor and @socadk. A user can now initialize the repository using adr init DIR madr. MADR not only uses a different template.md, but also a different status format (see https://github.com/adr/madr/issues/2). This is necessary, because MADR requires date and status information only when the status is not "Accepted".

We would be happy if this was included in adr-tools as adr-tools eases working with ADRs.

tangzhen commented 6 years ago

@npryce any update for this pull request?

npryce commented 6 years ago

I'm sorry. I'm not keen on supporting multiple formats. It adds non-trival maintenance overhead to ADR tools, and imposes complication on other tools that process the ADRs managed by adr-tools -- e.g. projects' documentation build pipelines, architecture visualisation tools. etc. Those tools would also have to become aware of the different formats, and how they define links between ADRs.

npryce commented 6 years ago

I'd be happier with multiple formats if there was a way to add formats in a non-intrusive way. E.g. without adding conditional logic that branches on format, and without the implementations of different formats having to be in the same repo as adr-tools itself. That way, each other format could be maintained by people who want to use it.