Skip to content
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

Add MADR support #43

Closed
wants to merge 3 commits into from
Closed

Add MADR support #43

wants to merge 3 commits into from

Conversation

snisnisniksonah
Copy link

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 adr/madr#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.

@snisnisniksonah snisnisniksonah changed the title Add MADR support [WIP] Add MADR support Jan 23, 2018
@snisnisniksonah snisnisniksonah changed the title [WIP] Add MADR support Add MADR support Jan 25, 2018
@tangzhen
Copy link

@npryce any update for this pull request?

@npryce
Copy link
Owner

npryce commented Jun 25, 2018

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 npryce closed this Jun 25, 2018
@npryce
Copy link
Owner

npryce commented Jun 25, 2018

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants