Make the adr-config configurable, per user, per project. about adr-tools HOT 5 CLOSED

@bcolferzd
I have tried it and it did not work.

Steps taken:

1. Check that the .adr-dir at the root of the project points to doc/architecture/decisions.
2. Save a template.md file in doc/architecture/decisions/ that contains the default template + one section (called 'More' in this example below):

# NUMBER. TITLE

Date: DATE

## Status

STATUS

## Context

The issue motivating this decision, and any context that influences or constrains the decision.

## Decision

The change that we're proposing or have agreed to implement.

## Consequences

What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.

## More

Some text.

3. run adr new test record.
4. it opens the default template, not the one I defined.

from adr-tools.

The adr-config script is not intended for users but for downstream packaging projects that package the application for various software distribution channels (Homebrew, APT, RPM and so forth).

If you want a per-project template, create a file named template.md in the ADR directory.

If you want the ADR directory to be at a different location, pass the directory you want to the adr init command.

from adr-tools.

If I am working with multiple teams each with their own template. We think it would be valuable for the project to define the template in the project repository.

from adr-tools.

@bcolferzd you can do that, as described in the first comment

from adr-tools.

@aurerua

A template file should be placed in ADR_DIR/templates/ not in ADR_DIR/.
So the correct path is doc/architecture/decisions/templates/template.md

source code:

from adr-tools.