Skip to content

docs(adr): add themed versioning, AI workflow and SDD records#596

Merged
nanotaboada merged 2 commits into
masterfrom
docs/adr-0011-0013
Jun 12, 2026
Merged

docs(adr): add themed versioning, AI workflow and SDD records#596
nanotaboada merged 2 commits into
masterfrom
docs/adr-0011-0013

Conversation

@nanotaboada

@nanotaboada nanotaboada commented Jun 12, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add ADR-0011: Use Coach-Themed Semantic Versioning — documents the v{MAJOR}.{MINOR}.{PATCH}-{coach} release tag convention with the full A–Z coach list and CD validation rationale
  • Add ADR-0012: Adopt AI-Assisted Development Workflow — documents Claude Code as the primary development tool and CLAUDE.md as the workflow specification
  • Add ADR-0013: Adopt Spec-Driven Development (SDD) — documents the Discuss → Specify → Implement three-step workflow using GitHub Issues as the durable spec artifact

Test plan

  • ADR files render correctly in GitHub Markdown
  • docs/adr/README.md index links resolve to the new files
  • CHANGELOG.md [Unreleased] section reflects all three additions
  • CLAUDE.md ADR range updated to ADR-0001–0013

🤖 Generated with Claude Code


This change is Reviewable

Summary by CodeRabbit

  • Documentation
    • Added three new Architecture Decision Records documenting standards for semantic versioning, development workflow, and feature specification processes.
    • Updated documentation index to reflect the expanded set of architectural decisions.

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@nanotaboada, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 29 minutes and 50 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more credits in the billing tab to continue.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 23dc1cf9-6174-4d23-aea4-ecef15dceb42

📥 Commits

Reviewing files that changed from the base of the PR and between 5e5eff0 and 307fb68.

📒 Files selected for processing (1)
  • docs/adr/0011-coach-themed-versioning.md

Walkthrough

This PR introduces three new Architecture Decision Records (ADRs) that document organizational decisions around release versioning, AI-assisted development workflow, and development practices. The three ADR documents are registered in the project's ADR index and changelog.

Changes

Architecture Decision Records (0011–0013)

Layer / File(s) Summary
ADR documents for versioning, workflow, and development process
docs/adr/0011-coach-themed-versioning.md, docs/adr/0012-ai-assisted-development-workflow.md, docs/adr/0013-spec-driven-development.md
ADR-0011 specifies Semantic Versioning with football-coach-themed release tags (v{MAJOR}.{MINOR}.{PATCH}-{coach}). ADR-0012 documents adoption of Claude Code as the primary development workflow with CLAUDE.md defining automation boundaries and CodeRabbit providing independent review. ADR-0013 records the Spec-Driven Development process requiring GitHub Issue specifications for non-trivial features and implementations that reference those Issues.
Documentation index and reference updates
CHANGELOG.md, CLAUDE.md, docs/adr/README.md
CHANGELOG.md adds entries for ADR-0011, ADR-0012, and ADR-0013 under [Unreleased]. CLAUDE.md updates the documented ADR range to 0001–0013. The ADR index table in docs/adr/README.md gains three new rows with links, titles, and status Accepted dated 2026-06-10.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title follows Conventional Commits format with 'docs:' prefix, is 61 characters (under 80), and clearly describes the main change—adding three new ADR documents.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/adr-0011-0013
  • 🛠️ sync documentation
  • 🛠️ enforce http error handling
  • 🛠️ idiomatic review
  • 🛠️ verify api contract

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.

@codecov

codecov Bot commented Jun 12, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (29dd02c) to head (307fb68).

Additional details and impacted files
@@            Coverage Diff            @@
##            master      #596   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            7         7           
  Lines          172       172           
=========================================
  Hits           172       172           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/adr/0011-coach-themed-versioning.md`:
- Around line 11-15: The comparison example wrongly cites "macOS" as an
alphabetical codename convention; update the text in
0011-coach-themed-versioning.md to remove or replace "macOS" with a true
alphabetical-codename example (e.g., "Android" which historically used
alphabetical dessert codenames) or simply keep only the correct "Ubuntu"
example, and ensure the sentence refers to "alphabetical codename conventions
(Ubuntu, Android)" or just "Ubuntu" for accuracy.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 85e261f8-3dc0-4c46-b7f0-8e4208fbea88

📥 Commits

Reviewing files that changed from the base of the PR and between 29dd02c and 5e5eff0.

📒 Files selected for processing (6)
  • CHANGELOG.md
  • CLAUDE.md
  • docs/adr/0011-coach-themed-versioning.md
  • docs/adr/0012-ai-assisted-development-workflow.md
  • docs/adr/0013-spec-driven-development.md
  • docs/adr/README.md

Comment thread docs/adr/0011-coach-themed-versioning.md Outdated
macOS uses California landmark names, not alphabetical codenames.
Replace with Android (A→P dessert names) as the correct example.

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
@sonarqubecloud

Copy link
Copy Markdown

@nanotaboada nanotaboada merged commit d1e49d2 into master Jun 12, 2026
11 checks passed
@nanotaboada nanotaboada deleted the docs/adr-0011-0013 branch June 12, 2026 04:03
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.

1 participant