adr-workflow
Skill4 starsChanged 7 months agoMITView on GitHub
Triggers when the agent makes technology selections, architectural pattern choices, or security/deployment strategy decisions. Covers ADR creation and conventions.
3 other projects use a version of this.
Adopted by
Most recently taken up by
- gabrielbauman/skillstheir own version, first seen Nov 1, 2026
- microsoft/devsquad-copilottheir own version, first seen Oct 16, 2026
- ramboz/jigtheir own version, first seen Jun 22, 2026
Other versions3 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 3
- microsoft/devsquad-copilot★ 50same name
- ramboz/jig★ 7same name
- gabrielbauman/skills★ 1same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository5 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- agent-frameworkSkill
- api-clientSkill
- databaseSkill
- releaseSkill
The file
We split this skill into the rules it gives an agent
2 rules. 0 are common, 2 are distinctive, and 0 are very specific to this project.
0
Common
Most of the 3 edited versions we read keep these.
2
Distinctive
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 12
NOT for trivial choices (CSS colour, variable naming)
- Distinctive: line 28
Keep it concise: 50-100 lines typical
“Common” is measured: kept by at least 6 in 10 of the 3 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
ADR Workflow
When to Write an ADR
- Technology or framework selection
- Significant architectural pattern choice
- Security or deployment strategy decisions
- NOT for trivial choices (CSS colour, variable naming)
Create a New ADR
- Find the next number:
ls docs/adr/*.md | tail -1 - Copy template:
cp docs/adr/template.md docs/adr/NNNN-short-description.md - Fill in all required sections (see below)
Required Sections
- Context — what situation or problem prompted this decision
- Decision Drivers — constraints, goals, or forces shaping the choice
- Decision — what was decided and why
- Consequences — trade-offs, risks, and follow-up work
Format
- Filename:
NNNN-kebab-case-description.md - Status:
Proposed->Accepted-> optionallyDeprecatedorSuperseded by NNNN - Keep it concise: 50-100 lines typical
Immutability Rule
- Accepted ADRs are immutable — never edit an accepted ADR
- New decisions supersede old ones: set old status to
Superseded by NNNN
Existing ADRs
- 18 ADRs covering: FastAPI, React, SQLAlchemy, Azure OpenAI, CSS Modules, OpenAPI gen, ARM templates, Container Apps, GitHub Actions, Pydantic settings, error boundaries, Alembic, Docker, scale-to-zero, fallback mode, GHCR, Log Analytics, Microsoft Agent Framework
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.