PR Design Doc
OpenHands/OpenHands
For a non-trivial pull request, write a self-contained HTML design doc under the temporary .pr/ directory and link a visibility-appropriate preview in the PR description, so maintainers grasp the…
Record an architecture decision as an ADR in api/docs/arch/adr/.
Install Adr
$ npx skills add linuxfoundation/insights --skill adr -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install linuxfoundation/insights adr --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/linuxfoundation/insights.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/adr .claude/skills/adr && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "adr" agent skill from https://github.com/linuxfoundation/insights/tree/main/.claude/skills/adr into .claude/skills/adr/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "adr", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/linuxfoundation/insights/tree/main/.claude/skills/adrType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add linuxfoundation/insights --skill adr -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install linuxfoundation/insights adr --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/linuxfoundation/insights.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.claude/skills/adr .agents/skills/adr && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "adr" agent skill from https://github.com/linuxfoundation/insights/tree/main/.claude/skills/adr into .agents/skills/adr/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "adr", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add linuxfoundation/insights --skill adr -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install linuxfoundation/insights adr --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/linuxfoundation/insights.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.claude/skills/adr .cursor/skills/adr && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "adr" agent skill from https://github.com/linuxfoundation/insights/tree/main/.claude/skills/adr into .cursor/skills/adr/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "adr", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/linuxfoundation/insights.git --path .claude/skills/adr--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add linuxfoundation/insights --skill adr -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install linuxfoundation/insights adr --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/linuxfoundation/insights.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.claude/skills/adr .gemini/skills/adr && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "adr" agent skill from https://github.com/linuxfoundation/insights/tree/main/.claude/skills/adr into .gemini/skills/adr/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "adr", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install linuxfoundation/insights adrInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add linuxfoundation/insights --skill adr -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/linuxfoundation/insights.git skills-src && mkdir -p .github/skills && cp -r skills-src/.claude/skills/adr .github/skills/adr && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "adr" agent skill from https://github.com/linuxfoundation/insights/tree/main/.claude/skills/adr into .github/skills/adr/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "adr", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add linuxfoundation/insights --skill adr -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install linuxfoundation/insights adr --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/linuxfoundation/insights.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.claude/skills/adr .opencode/skills/adr && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "adr" agent skill from https://github.com/linuxfoundation/insights/tree/main/.claude/skills/adr into .opencode/skills/adr/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "adr", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
adr- GitHub stars
- 280
- Token cost
- ~1k tokens
- SKILL.md length
- 443 words
- Files
- 1
- Skills in repo
- 9
- Repo updated
- First seen
- Licence
- MIT
At a glance
Record an architecture decision as an ADR in api/docs/arch/adr/.
- Works in 7 steps: Scan existing ADRs — Glob… → Assign next ID — next sequential 4-digit… → Gather context — ask the user for any… → …
- Choosing between frameworks
- SKILL.md covers When to record, ADR template, Workflow — recording a new ADR and Workflow — reading / querying…, plus 1 more section
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
Adr is an agent skill from linuxfoundation/insights. Record an architecture decision as an ADR in api/docs/arch/adr/. Use when choosing between frameworks, libraries, databases, or architectural patterns; stating a decision with reasoning ("we decided X instead of Y because..."); or querying past decisions ("why did we choose X?").
Its SKILL.md is about 1k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in Development, covering Architecture decision records. The repository describes itself as: Insights into the world's most critical open source software. The licence is MIT.
When your agent uses it
- Choosing between frameworks
- Architectural patterns
- Stating a decision with reasoning (we decided X instead of Y because...)
- Querying past decisions (why did we choose X?)
Example prompts
- “we decided X instead of Y because...”
- “why did we choose X?”
- “/adr”
Requirements
- Pre-approved tools (allowed-tools): Read, Write, Edit, Glob, Grep, AskUserQuestion
Workflow steps
7 steps, taken from the first numbered list in SKILL.md.
- Scan existing ADRs — Glob api/docs/arch/adr/[0-9]*.md to find the highest existing number.
- Assign next ID — next sequential 4-digit number (e.g., 0003).
- Gather context — ask the user for any missing details on the context, the decision, and the alternatives considered with why they were…
- Draft the ADR — cover the context, decision, and rejected alternatives, either as free-form prose or using the full template above.
- Present the draft — show it to the user for review before writing any file.
- Write the file — api/docs/arch/adr/NNNN-kebab-title.md (kebab-case title, all lowercase).
- Update the index — append a new row to the | ADR | Title | Status | Date | table in api/docs/arch/adr/README.md.
What it can do on your machine
Read from SKILL.md and the folder at commit 3df53b5. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves these tools, so the agent can use them without asking each time:
ReadWriteEditGlobGrepAskUserQuestion
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md (its code samples are markdown).
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Adr loads about 1k tokens when it runs. Until then it costs about 71 tokens; SKILL.md has 443 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from linuxfoundation/insights at commit 3df53b5, republished under its MIT licence (© linuxfoundation). 443 words, ~1,048 tokens.
Download SKILL.mdSave it as
.claude/skills/adr/SKILL.md (or your agent's skills folder).- name
- adr
- description
- Record an architecture decision as an ADR in api/docs/arch/adr/. Use when choosing between frameworks, libraries, databases, or architectural patterns; stating a decision with reasoning ("we decided X instead of Y because..."); or querying past decisions ("why did we choose X?").
- allowed-tools
- Read, Write, Edit, Glob, Grep, AskUserQuestion
Architecture Decision Records
You are recording or retrieving an Architecture Decision Record (ADR) for this
project. ADRs live in api/docs/arch/adr/ at the repo root.
When to record
Record these decisions:
- Technology selections (frameworks, libraries, databases, cloud providers)
- Architectural patterns (state management, caching strategy, API design)
- Data modeling choices (schema design, indexing, query approach)
- Infrastructure and deployment models
- Security, authentication, or testing strategy changes
- Any choice where the "why we didn't pick the alternative" will matter in 6 months
Skip: trivial choices (variable naming, formatting, minor refactors).
ADR template
Every ADR must have an H1 title stating the decision, and body prose covering
the context, the decision itself, and the alternatives considered with why
they were rejected. README.md and template.md are index/template files,
not ADRs, and are exempt from this requirement.
The body may be short free-form prose covering those points, or the full
template below (Date/Status/Deciders header block, Context, Decision,
Alternatives Considered, Consequences). The full template is recommended for
new ADRs but not required — the **Deciders**: line is always optional. If
the decision, its context, or the rejected alternatives can't be stated, stop
and ask the user for the missing information before writing the file.
# ADR-NNNN: [Decision Title]
**Date**: YYYY-MM-DD
**Status**: proposed | accepted | deprecated | superseded by ADR-NNNN
**Deciders**: [who was involved]
## Context
[2–5 sentences describing the situation, constraints, and forces at play]
## Decision
[1–3 sentences stating the change clearly and unambiguously]
## Alternatives Considered
### Alternative 1: [Name]
- **Pros**: [benefits]
- **Cons**: [drawbacks]
- **Why not**: [specific rejection reason]
### Alternative 2: [Name]
- **Pros**: [benefits]
- **Cons**: [drawbacks]
- **Why not**: [specific rejection reason]
## Consequences
### Positive
- [benefit 1]
### Negative
- [trade-off 1]
### Risks
- [risk and mitigation]Workflow — recording a new ADR
- Scan existing ADRs —
Glob api/docs/arch/adr/[0-9]*.mdto find the highest existing number. - Assign next ID — next sequential 4-digit number (e.g.,
0003). - Gather context — ask the user for any missing details on the context, the decision, and the alternatives considered with why they were rejected. Only ask about deciders and consequences if the user opts into the full template.
- Draft the ADR — cover the context, decision, and rejected alternatives, either as free-form prose or using the full template above.
- Present the draft — show it to the user for review before writing any file.
- Write the file —
api/docs/arch/adr/NNNN-kebab-title.md(kebab-case title, all lowercase). - Update the index — append a new row to the
| ADR | Title | Status | Date |table inapi/docs/arch/adr/README.md.
Show full SKILL.md (121 more words)Show less
Workflow — reading / querying ADRs
- Check if
api/docs/arch/adr/README.mdexists. If not, offer to start the ADR directory. - Read the README index table and find entries relevant to the user's question.
- Read the matching ADR file and summarise the Context and Decision sections.
- If no ADR matches, suggest recording one now.
Quality standards
- Each ADR should be readable in under 2 minutes.
- Every rejected alternative must include a Why not reason — "we didn't pick X" without a reason is useless.
- When a decision is superseded, update the old ADR's Status field to
superseded by ADR-NNNNand create the new ADR with a back-reference in its Context. - Keep one decision per ADR — split if two separate choices are getting conflated.
© linuxfoundation, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
Just SKILL.md in .claude/skills/adr of linuxfoundation/insights.
Open the folder on GitHubat commit 3df53b5
Compare with similar skills
Adr next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Adr this skilllinuxfoundation/insights | 280 | — | ~1k | Automated safety check: Pass | MIT | |
| PR Design DocOpenHands/OpenHands | 90k | — | ~2.4k | Automated safety check: Pass | MIT | |
| Cto AdvisorIbrahim-3d/orchestrator-supaconductor | 380 | 4 repos | ~2.4k | Automated safety check: Pass | MIT | |
| Improve Codebase Architectureywwynm/EverythingDone | 144 | 15 repos | ~1.3k | Automated safety check: Pass | GPL-3.0 | |
| Domain Modelingbrim-borium/spotify_sdk | 166 | 5 repos | ~806 | Automated safety check: Pass | Apache-2.0 | |
| Design Doc MermaidSpillwaveSolutions/design-doc-mermaid | 175 | 1 repos | ~5.6k | Automated safety check: Pass | None |
Similar skills
Cto Advisor
Ibrahim-3d/orchestrator-supaconductor
Technical leadership guidance for engineering teams, architecture decisions, and technology strategy.
Improve Codebase Architecture
ywwynm/EverythingDone
Find deepening opportunities in a codebase, informed by the domain language in CONTEXT.md and the decisions in docs/adr/.
Domain Modeling
brim-borium/spotify_sdk
Build and sharpen a project's domain model. An agent skill from brim-borium/spotify_sdk.
Design Doc Mermaid
SpillwaveSolutions/design-doc-mermaid
Create Mermaid diagrams (flowchart, sequence, class, ER, state, C4, architecture) from text or source code.
Learning Opportunities
DrCatHicks/learning-opportunities
Facilitates deliberate skill development during AI-assisted coding.
More from linuxfoundation/insights
All 9 skills in this repoEvent Tracking
linuxfoundation/insights
Add event tracking calls to Vue/Nuxt components in the Insights app using the useTrackEvent composable.
Review PR
linuxfoundation/insights
Review a pull request against Insights architecture standards — fetches PR diff, verifies previous comments are addressed, validates PR metadata (title, branch, JIRA, size), runs a code-standards…
Dco
linuxfoundation/insights
Recover from missing DCO sign-off on commits. An agent skill from linuxfoundation/insights.
Fix Vulns
linuxfoundation/insights
Automated triage and fixing of Dependabot security vulnerabilities (IN-1189).
Setup
linuxfoundation/insights
Full development environment setup from scratch — prerequisites, dependencies, .env file, optional local PostgreSQL database (for auth/collections/chat work), and dev server.
Setup Docs
linuxfoundation/insights
Run the docs site, blog, or Storybook locally. An agent skill from linuxfoundation/insights.
Related
Categories
Questions about Adr
What does Adr do?
Record an architecture decision as an ADR in api/docs/arch/adr/. Adr is an agent skill from linuxfoundation/insights. Record an architecture decision as an ADR in api/docs/arch/adr/.
When should I use Adr?
Adr fits situations like: choosing between frameworks; architectural patterns; stating a decision with reasoning (we decided X instead of Y because...); querying past decisions (why did we choose X?).
How do I install Adr in Claude Code?
Run `npx skills add linuxfoundation/insights --skill adr -a claude-code`. Or copy the skill folder (.claude/skills/adr in linuxfoundation/insights) into .claude/skills/adr in your project. Claude Code loads it when a task matches its description.
How do I install Adr in Codex?
Run `npx skills add linuxfoundation/insights --skill adr -a codex`. Or copy the skill folder (.claude/skills/adr in linuxfoundation/insights) into .agents/skills/adr in your project. Codex loads it when a task matches its description.
Can I use Adr in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add linuxfoundation/insights --skill adr -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/adr, .gemini/skills/adr, .github/skills/adr and .opencode/skills/adr in your project.
What does Adr need to run?
SKILL.md names no scripts, command-line tools or credentials: Adr is instructions for the agent only. Its frontmatter pre-approves these tools: Read, Write, Edit, Glob, Grep, AskUserQuestion.
Does Adr access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Adr safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does Adr use?
Adr is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Adr use?
About 1k tokens (SKILL.md is roughly 4.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Adr?
Skills that share tags, products or a category with Adr: PR Design Doc (OpenHands/OpenHands, 90k stars), Cto Advisor (Ibrahim-3d/orchestrator-supaconductor, 380 stars), Improve Codebase Architecture (ywwynm/EverythingDone, 144 stars) and Domain Modeling (brim-borium/spotify_sdk, 166 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Adr?
linuxfoundation (a GitHub organization) maintains it in linuxfoundation/insights, which has 280 GitHub stars. The repository holds 9 skills in this directory. The repository was last updated on October 1, 2026.
Source: linuxfoundation/insights on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.