Skip to content

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

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

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

Conversation

@nanotaboada

@nanotaboada nanotaboada commented Jun 12, 2026

Copy link
Copy Markdown
Owner

Summary

  • Moves all ADRs from adr/ (repo root) to docs/adr/ for consistency with the project documentation structure
  • Adds ADR-0009: Use Ballon d'Or-Themed Semantic Versioning
  • Adds ADR-0010: Adopt AI-Assisted Development Workflow (adapted from Java sibling repo ADR-0013)
  • Adds ADR-0011: Adopt Spec-Driven Development (SDD) (adapted from Java sibling repo ADR-0014)

Test plan

  • cargo fmt — clean
  • cargo clippy --all-targets --all-features -- -D warnings — clean
  • cargo build — succeeds
  • cargo test — 44 tests pass
  • docs/adr/README.md index lists ADRs 0001–0011
  • CHANGELOG.md [Unreleased] lists ADR-0009, ADR-0010, ADR-0011
  • CLAUDE.md "Current ADRs:" list includes all 11 entries with docs/adr/ paths

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Added Architecture Decision Records covering Ballon d'Or-themed semantic versioning, AI-assisted development workflow, and spec-driven development practices.
    • Updated development guidance and ADR index documentation.
  • Chores

    • Enhanced pre-commit checklist with mandatory 80% code coverage gate.
    • Updated CI and code review configuration references.

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 45 minutes and 46 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: f8d09a03-4f07-4406-99de-824637073e4a

📥 Commits

Reviewing files that changed from the base of the PR and between 7e06760 and 183c6f1.

📒 Files selected for processing (1)
  • CHANGELOG.md

Walkthrough

This PR documents three new Architecture Decision Records that establish semantic versioning, AI-assisted development workflow, and spec-driven development practices, then updates project configuration and documentation to catalog and enforce these decisions across pre-commit checks and guidance files.

Changes

ADR Governance and Coverage Enforcement

Layer / File(s) Summary
New Architecture Decision Records (0009–0011)
docs/adr/0009-ballon-dor-themed-versioning.md, docs/adr/0010-ai-assisted-development-workflow.md, docs/adr/0011-spec-driven-development.md
ADR-0009 specifies Ballon d'Or-themed semantic versioning with v{MAJOR}.{MINOR}.{PATCH}-{surname} tag format; ADR-0010 establishes Claude Code as the primary AI-assisted development workflow and defines CLAUDE.md as workflow specification with explicit autonomy boundaries; ADR-0011 defines three-step spec-driven development process (Discuss, Specify via Issue, Implement with traceable commits).
ADR Catalog and Documentation Updates
docs/adr/README.md, CHANGELOG.md, CLAUDE.md, .claude/commands/pre-commit.md
ADR index is extended with entries for ADR-0009, ADR-0010, and ADR-0011; CHANGELOG.md documents ADRs under docs/adr/ path and adds the three new entries to the Added section; CLAUDE.md updates path references and Current ADRs list; pre-commit checklist inserts cargo tarpaulin --fail-under 80 coverage gate and adjusts execution step numbering.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~20 minutes

Possibly related PRs

  • nanotaboada/rust-samples-rocket-restful#118: Both PRs modify the project's Architecture Decision Records documentation workflow by updating CHANGELOG.md/CLAUDE.md and extending the ADR set/index entries.
  • nanotaboada/rust-samples-rocket-restful#114: This PR's updates to CLAUDE.md and pre-commit coverage enforcement align with prior consolidation and rewriting of CLAUDE.md and related instruction/config guidance.
  • nanotaboada/rust-samples-rocket-restful#59: Main PR adds ADR-0009 documenting Ballon d'Or-themed tag/semver naming convention that aligns with retrieved PR's CD workflow parsing and validation of the same v{X}.{Y}.{Z}-{NOMINEE} format.
🚥 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 ADRs (0009–0011) to the documentation.
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-0009-0011
  • 🛠️ 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.

@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 `@CHANGELOG.md`:
- Around line 47-50: Update the CHANGELOG.md entry that currently reads "8 ADRs
(0001–0008)" in the [Unreleased] section so it accurately reflects the ADRs now
included by this PR; change it to "11 ADRs (0001–0011)" (or move the "8 ADRs"
note into the previous release if preserving historical context), and ensure
ADR-0009, ADR-0010, and ADR-0011 are represented in the same Unreleased header
alongside the existing ADRs.
🪄 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: ad67c52c-ee77-4e9d-a7df-f4fd3fd8035c

📥 Commits

Reviewing files that changed from the base of the PR and between 6c55d55 and 7e06760.

📒 Files selected for processing (16)
  • .claude/commands/pre-commit.md
  • CHANGELOG.md
  • CLAUDE.md
  • docs/adr/0001-adopt-rocket-as-rest-api-framework.md
  • docs/adr/0002-four-layer-architecture.md
  • docs/adr/0003-diesel-r2d2-bundled-sqlite.md
  • docs/adr/0004-uuid-surrogate-squad-number-natural-key.md
  • docs/adr/0005-full-replace-put-no-patch.md
  • docs/adr/0006-embed-migrations-startup-schema.md
  • docs/adr/0007-integration-only-test-strategy.md
  • docs/adr/0008-docker-compose-strategy.md
  • docs/adr/0009-ballon-dor-themed-versioning.md
  • docs/adr/0010-ai-assisted-development-workflow.md
  • docs/adr/0011-spec-driven-development.md
  • docs/adr/README.md
  • docs/adr/template.md

Comment thread CHANGELOG.md Outdated
@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 84.88%. Comparing base (cbc44f3) to head (183c6f1).
⚠️ Report is 4 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #123   +/-   ##
=======================================
  Coverage   84.88%   84.88%           
=======================================
  Files           6        6           
  Lines         172      172           
=======================================
  Hits          146      146           
  Misses         26       26           

☔ 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.

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
@nanotaboada
nanotaboada merged commit ae3b719 into master Jun 12, 2026
10 checks passed
@nanotaboada
nanotaboada deleted the docs/adr-0009-0011 branch June 12, 2026 04:04
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