skills.rest
dotCMS
dotCMSOFFICIAL
Explore all skills by this author →
WebsiteGitHub

speckit-adr-context

Retrieves relevant Architecture Decision Records from dotCMS/platform-adrs to inform feature planning.

950|482|Updated Mar 15, 2012
Search Tags:#ADR#architecture decisions#Planning#dotcms#gitHub cli#spec-Kit#before_plan hook
One-click install
npx skills add https://github.com/dotCMS/core --skill speckit-adr-context
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: speckit-adr-context
Source: https://github.com/dotCMS/core/tree/main/.claude/skills/speckit-adr-context
Command: npx skills add https://github.com/dotCMS/core --skill speckit-adr-context

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

When planning a new feature or fix in dotCMS, engineers risk violating existing architectural decisions because ADRs live in a separate private repository. This Skill surfaces the relevant Architecture Decision Records before planning begins, so existing decisions are treated as binding input rather than discovered after the fact.

Core Features & Use Cases

  • Keyword-based ADR lookup: Derives search keywords from the current feature spec (subsystem, technologies, data stores) or accepts them as arguments, then queries the dotCMS/platform-adrs repository via the gh CLI.
  • Status-aware summarization: Reads matching ADR bodies and distinguishes accepted ADRs (binding) from proposed ones (directional), flagging likely conflicts that must be resolved in the plan.
  • Read-only by design: Never creates, edits, or commits ADRs; new decisions are only recorded as proposals in the plan's Proposed ADRs section.
  • Use Case: Before running /speckit-plan on a feature touching Elasticsearch indexing, invoke this Skill to pull all search-related ADRs and fold them into the plan's ADR Alignment gate.

Quick Start

Run the speckit-adr-context skill with keywords like "search elasticsearch" to list the ADRs relevant to your current feature before planning.

Frequently Asked Questions about speckit-adr-context

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I find relevant ADRs before planning a dotCMS feature?▼

Run the adr-context lookup script with keywords describing your feature's subsystem, technologies, and data stores. The skill queries the dotCMS/platform-adrs repository via the gh CLI and returns matching ADRs with their status and relevance.

How do I read the full body of an ADR in dotCMS/platform-adrs?▼

Use the GitHub API through the gh CLI: gh api repos/dotCMS/platform-adrs/contents/decisions/<file>.md -q .content piped to base64 -d. This decodes and prints the full ADR markdown for review.

Can this skill create or edit Architecture Decision Records?▼

No, the skill is strictly read-only and never creates, edits, or commits ADRs. New decisions are only recorded as proposals in the plan's Proposed ADRs section, then authored separately in dotCMS/platform-adrs using its new-adr.sh process.

What happens if the ADR lookup fails due to permissions?▼

The lookup script always exits 0, so planning is never blocked. If a network or permission problem is reported, check gh auth status and review dotCMS/platform-adrs/INDEX.md manually, then continue planning.

Does the skill work without access to the private platform-adrs repo?▼

No, it requires an authenticated gh CLI with read access to the private dotCMS/platform-adrs repository. Without that access, you must review the ADR index manually through whatever access channel your organization provides.

Related Skills

Explore More Software Engineering Skills→
linhnguyen125linhnguyen125

speckit-clarify

Generate up to five targeted clarification questions for underspecified feature specs.

Community
Advanced
juliusljuliusl
1

implement-adr

Decompose ADRs into staged tasks and generate plan.md files with estimates.

Community
Advanced
0xdeafcafe0xdeafcafe

backfill-feature

Backfill retroactive ADRs, Gherkin specs, and characterization tests for existing software features.

Community
Advanced
zorgentechzorgentech

create-adr

Create Architecture Decision Records from pull request metadata and diffs.

Official
Intermediate