Skip to content

Add portable Architecture Decision Records (ADR) AI skill#2

Draft
dongnt97 wants to merge 1 commit into
mainfrom
cursor/adr-skill-12cf
Draft

Add portable Architecture Decision Records (ADR) AI skill#2
dongnt97 wants to merge 1 commit into
mainfrom
cursor/adr-skill-12cf

Conversation

@dongnt97

@dongnt97 dongnt97 commented Jun 5, 2026

Copy link
Copy Markdown
Owner

Summary

Adds a single, tool-agnostic AI skill that teaches any AI IDE/agent to record why architectural decisions were made, using Architecture Decision Records (ADRs).

Same portable format as the Python skill: plain Markdown with YAML front matter (Anthropic Agent Skills SKILL.md), usable across Claude/Claude Code, Cursor, GitHub Copilot, Windsurf, Codeium, Cline, Aider, and any Markdown-reading agent.

Files

  • skills/architecture-decision-records/SKILL.md — the skill content
  • skills/architecture-decision-records/template.md — copy-per-decision ADR template
  • skills/architecture-decision-records/examples/ADR-0001-use-postgresql.md — filled-in example
  • skills/architecture-decision-records/README.md — how to enable it per tool

Topics covered

  • ADR template: Context, Decision, Consequences (positive + trade-offs), Alternatives Considered + metadata (status, date, deciders, tags)
  • What is "architecturally significant" enough to warrant an ADR
  • Naming conventionADR-NNNN-kebab-case-title.md (e.g. ADR-0001-use-postgresql.md), stored in docs/adr/, never renumbered
  • Status lifecycle — Proposed → Accepted / Rejected / Deprecated / Superseded (immutable history; supersede, don't overwrite)
  • Review & approval process via PRs, with communication and revisiting
  • Best practices / anti-patterns and how ADRs help onboard new teammates

Notes

  • Documentation-only change; no source code or build affected.
Open in Web Open in Cursor 

Co-authored-by: dongnt97 <dongnt97@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Jun 5, 2026

Copy link
Copy Markdown

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5d4c48e5-9701-4122-aeae-ab32e0a3bd99

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch cursor/adr-skill-12cf

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants