Skip to content

Make directory and decision record template configurable via yaml config file #1

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

Merged
merged 6 commits into from
Jul 3, 2018

Conversation

abachmann
Copy link
Contributor

@abachmann abachmann commented Jun 30, 2018

I would like to use my own ADR template and unfortunately it was not possible. Therefore I introduced a configuration file. Additionally I made the workspace directory configurable via configuration file as well. That's why I removed the "directory" option from the commands.

This is of course a BC, but in my opinion it should not be a big problem for this project.

It would also be very helpful to have a table of contents for all ADRs. What do you think?

@globtec
Copy link
Owner

globtec commented Jul 3, 2018

You will need to use some keyword besides sequence, title, date and status?
Can you share your ADR template?

I liked of idea of create a table of contents for all ADRs, I thought of the following template:

# Architecture Decision Records 

These are the architectural decisions that are taken while developing this project, follows list of these records:

1. [Documenting architecture decisions](0001-documenting-architecture-decisions.md)
2. [Develop tool to manage ADRs](0002-develop-tool-to-manage-adrs.md)
3. continue...

@globtec globtec merged commit 1cb93da into globtec:master Jul 3, 2018
@abachmann
Copy link
Contributor Author

abachmann commented Jul 3, 2018

For me, the existing keywords are quite sufficient.

I searched for existing ADR templates and found a few I liked:

The following template is a mixture of the existing ones:

I just want to start documenting decisions in this way. So maybe the template will change over time.

I like your template for the table of contents. Do you have time to add the table of contents? Otherwise I will do it.

Thank you for accepting my PR by the way.

Asenar pushed a commit to Asenar/phpadr that referenced this pull request Jan 15, 2025
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.

2 participants