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

Recommended directory structure #6

Closed
pixelbrackets opened this issue Feb 15, 2018 · 1 comment
Closed

Recommended directory structure #6

pixelbrackets opened this issue Feb 15, 2018 · 1 comment

Comments

@pixelbrackets
Copy link
Contributor

As written in the summary this repository “provides an initial directory structure and files to document Architectural Decisions using Markdown and Architectural Decision Records.”

The files (= the template) are explained in the README, the directory structure however is not. It's just presumed in the section Create a new ADR.
It would be nice to explain that the directory structure uses NNNN-title-with-dashes.md format and why it does so (other ADRs styles for example recommend using YYYY-MM-DD Title without Dahes or YYYY-MM-DD-title-with-dashes, so this difference should be explained somewhere).

@koppor koppor closed this as completed in c62a716 Feb 16, 2018
@koppor
Copy link
Member

koppor commented Feb 16, 2018

We removed the "initial directory structure" at 23a9277, because we want to use MADR for ourselves to document decisions taken at MADR. This update was missing updating the README.md completely. I fixed that in c62a716.

This issue was closed.
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

2 participants