Skip to content

Commit eb5a5df

Browse files
committed
docs(adr-author): explicitly copy template to target repo if missing
1 parent 4927be1 commit eb5a5df

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

skills/adr-author/SKILL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Invoke this skill when you want to create a new Architecture Decision Record.
2121
## Prerequisites
2222

2323
- The repository keeps ADRs in a standard location, typically `docs/adr/`.
24-
- An index of ADRs (e.g., `docs/adr/README.md`) and a template (e.g., `docs/adr/template.md`) usually exist in this directory. If a `template.md` does not exist in the target repository, use the `template.md` provided alongside this skill.
24+
- An index of ADRs (e.g., `docs/adr/README.md`) and a template (e.g., `docs/adr/template.md`) usually exist in this directory. If a `template.md` does not exist in the target repository, copy the `template.md` provided alongside this skill into the target repository's `docs/adr/` directory so it is available for future use.
2525

2626
## Conventions
2727

@@ -53,7 +53,7 @@ Do NOT write ADRs for routine bug fixes, version bumps, or anything self-evident
5353

5454
1. Read the 2-3 latest ADRs in the repository (e.g., in `docs/adr/`) to understand the established tone and context.
5555
2. Determine the next sequential number `NNNN` for the new ADR.
56-
3. Copy the `template.md` (from the repository or from this skill's directory) to `docs/adr/NNNN-<kebab-case-title>.md`.
56+
3. Copy the `template.md` (from the repository or from this skill's directory) to `docs/adr/NNNN-<kebab-case-title>.md`. If the target repository did not have a template, also save a copy of the template to `docs/adr/template.md`.
5757
4. Fill in the template following the content guidance above.
5858
5. If the new ADR supersedes an older one, edit the old ADR's Status to `Superseded by NNNN`.
5959
6. Add an entry for the new ADR to the index file (`docs/adr/README.md`).

0 commit comments

Comments
 (0)