Skip to content

docs(#11): pin the adoption path to a tagged release #22

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.

Sign up for GitHub

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

Open
me2resh wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs(#11): pin the adoption path to a tagged release #22

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a87aee
docs: pin the adoption path to a tagged release
me2resh Aug 7, 2026
0ed3f59
docs: state the accurate harm of vendoring from main
me2resh Aug 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,14 @@ AgDR is a plain standard, not a product — **you don't need ApexYard or any fra
2. **The schema** — [`schema/agdr.schema.json`](schema/agdr.schema.json), so frontmatter is machine-checkable.
3. **The check** — vendor [`scripts/validate-agdr.js`](scripts/validate-agdr.js) (or the [`validate-agdr.yml`](.github/workflows/validate-agdr.yml) workflow) so CI rejects malformed records.

**Pin a version.** Those three files are a snapshot of a versioned standard, so take them from a tagged [release](https://github.com/me2resh/agent-decision-record/releases) rather than from `main` — otherwise nothing records *which* version you adopted, and the next person to re-vendor quietly picks up a different one:

```bash
git clone --branch v1.2.0 --depth 1 https://github.com/me2resh/agent-decision-record.git
```

That tag is also what you cite when you record adopting AgDR as an AgDR of your own. [CHANGELOG.md](CHANGELOG.md) lists what changed between versions.

Or wire it into your agent directly:

### Install as Claude Code Plugin
Expand Down
Loading