chore: add use-case spec skill#198
Merged
Merged
Conversation
📝 WalkthroughWalkthroughA new Changesaxis-use-case-spec skill and routing wiring
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (2)
.agents/skills/axis-use-case-spec/SKILL.md (2)
1-10: ⚡ Quick winAdd navigation backlink to match skill template conventions.
Per the playbook style guide, skill documentation files should include a navigation backlink to the parent index, enabling readers to navigate up. Add a backlink after the H1.
📍 Suggested navigation line after H1
# Axis Use Case Spec > **Navigation**: [← .agents/skills/README.md](...) · [← agent-checklist.md](../../docs/playbooks/agent-checklist.md)(Confirm the relative path to
.agents/skills/README.mdor the equivalent parent index for skills.)🤖 Prompt for 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. In @.agents/skills/axis-use-case-spec/SKILL.md around lines 1 - 10, The SKILL.md file is missing a navigation backlink after the H1 heading "# Axis Use Case Spec" that should enable readers to navigate back to the parent index. Add a backlink line immediately after the H1 heading that points to the parent skills index at `.agents/skills/README.md` using a relative path reference, following the playbook style guide conventions for skill documentation navigation.Source: Coding guidelines
44-55: ⚡ Quick winConsolidate repetitive routing instructions into a table for scannability.
Lines 45–54 each open with "Use" or "Run", making the prose dense and harder to scan. Replace with a table or use inline code references with colons to improve readability and align with playbook prose style.
🔧 Suggested consolidation using a reference table
Replace lines 44–49 with:
6. Route follow-up implementation. | Surface | Skill | |---------|-------| | REST/OpenAPI/API type changes | `$axis-api-contract` | | Events, commands, jobs, saga steps, Kafka, RabbitMQ, Wolverine, gRPC, Avro, or proto | `$axis-cross-module-contract` | | SPA routes, feature folders, forms, data fetching, or UI behavior | `$axis-frontend-feature` | | Implementation (only after spec exists and decisions resolved) | `$axis-use-case-implementation` |Then replace lines 50–54 with a similar table for verification commands:
7. Verify the spec. | Check | Command | |-------|---------| | Use-case docs | `python scripts/axis.py check use-case-docs` | | Navigation | `python scripts/axis.py check doc-navigation` | | Markdown links (if changed) | `python scripts/axis.py check markdown-links` | | Wireframes (if Excalidraw/SVG changed) | `python scripts/axis.py generate wireframes` |🤖 Prompt for 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. In @.agents/skills/axis-use-case-spec/SKILL.md around lines 44 - 55, The "Route follow-up implementation" section and "Verify the spec" section in SKILL.md contain repetitive structures that begin with "Use" and "Run" respectively, making the content dense and difficult to scan. Consolidate the Route follow-up implementation section (the list of items starting with "Use $axis-api-contract") into a reference table with columns for contract type and use case, and similarly consolidate the Verify the spec section (the list of items starting with "Run python scripts/axis.py") into a table with columns for verification type and command. This will improve readability and align with playbook prose style conventions.Source: Coding guidelines
🤖 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.
Nitpick comments:
In @.agents/skills/axis-use-case-spec/SKILL.md:
- Around line 1-10: The SKILL.md file is missing a navigation backlink after the
H1 heading "# Axis Use Case Spec" that should enable readers to navigate back to
the parent index. Add a backlink line immediately after the H1 heading that
points to the parent skills index at `.agents/skills/README.md` using a relative
path reference, following the playbook style guide conventions for skill
documentation navigation.
- Around line 44-55: The "Route follow-up implementation" section and "Verify
the spec" section in SKILL.md contain repetitive structures that begin with
"Use" and "Run" respectively, making the content dense and difficult to scan.
Consolidate the Route follow-up implementation section (the list of items
starting with "Use $axis-api-contract") into a reference table with columns for
contract type and use case, and similarly consolidate the Verify the spec
section (the list of items starting with "Run python scripts/axis.py") into a
table with columns for verification type and command. This will improve
readability and align with playbook prose style conventions.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 71cdc7d4-c9c4-4ee6-88eb-cd42f5f31eaf
📒 Files selected for processing (6)
.agents/skills/axis-use-case-implementation/SKILL.md.agents/skills/axis-use-case-spec/SKILL.md.agents/skills/axis-use-case-spec/agents/openai.yamlAGENTS.mddocs/playbooks/agent-checklist.mddocs/playbooks/design-gate.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
axis-use-case-specso docs-first use cases can be created or tightened before implementation starts. Updates use-case implementation and routing docs so missing README/AC coverage now routes through the spec skill before code work.Linked spec
.agents/skills/axis-use-case-spec/SKILL.md.agents/skills/axis-use-case-implementation/SKILL.mddocs/playbooks/agent-checklist.mddocs/playbooks/design-gate.mdRequirements & rules followed
AGENTS.md,agent-checklist, anddesign-gaterouting updated for the new skill.TODO/FIXME/NotImplementedException/ placeholder / stub undersrc/,tests/,frontend/src/; skill template placeholders removed.Summary by CodeRabbit
New Features
Documentation