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

Print title of ADRs #5

Closed
koppor opened this issue Oct 22, 2017 · 2 comments
Closed

Print title of ADRs #5

koppor opened this issue Oct 22, 2017 · 2 comments

Comments

@koppor
Copy link
Member

koppor commented Oct 22, 2017

An architectural decision record always has a title. See https://github.com/adr/madr/blob/master/docs/adr/template.md

The template is used at Eclipse Winery - see https://github.com/eclipse/winery/tree/master/docs/adr, which can be used for testing.

The MADR repository also contains an index file: https://github.com/adr/madr/blob/master/docs/adr/index.md. This index file describes the output. Please adapt adr-log to this output.

grafik

@koppor
Copy link
Member Author

koppor commented Oct 22, 2017

Even better would be that format:

ADR-0000 - Use Markdown Archictural Decision Records (MADR)

Where ADR-0000 links to 0000-use-markdown-architectural-decision-records.md. Would that be possible? For the 0001-...., it is ADR-0001 with using the title of the linked ADR file.

@koppor
Copy link
Member Author

koppor commented Oct 22, 2017

  • Please add a special handling for template.md. The title is ALWAYS The template and not the one in template.md.

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

No branches or pull requests

1 participant