search

npryce / adr-tools

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

mulitple folders in .adr-dir #51

Closed jeevemula closed 6 years ago

jeevemula commented 6 years ago

Hi I am managing a folder structure as belows:

doc > architecture > front-end doc > architecture > back-end

Every time I use adr new I had to overwrite .adr-dir file.

Is there a way to accommodate multiple folder structure.

npryce commented 6 years ago

Not something I'd thought of before.

If you want to document decisions about different components of the architecture, instead of the overall system architecture, could you run adr-tool in the subdirectory for each component?

E.g. if you have a repo structure like:

<project-root>/
   +-- back-end/
   |
   +-- front-end/

You could run cd into back-end and run adr init, then into front-end/ and run adr-init, to have an ADR log for each component. And you could also have an ADR log under the root for recording decisions that affect the whole system.

npryce commented 6 years ago

Would feature suggested by #48 be a solution? If that was implemented, you could wrap adr-tool in project-specific scripts that would enforce a distinction between your app components.

npryce commented 6 years ago

Closing because you can use adr init to create multiple ADR directories in the same Git repo already, and because this use case would be supported by #48.