chore(AI): Recommend OpenSpec for scoping AI-assisted changes - #1005
Conversation
📝 WalkthroughWalkthroughAdds OpenSpec workflow guidance, routes six OpenSpec skills in ChangesOpenSpec tooling
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 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 |
Split out of #1002's OpenSpec-adjacent bits so that PR's tool-version pinning work doesn't have to wait on this. Adds an AI_POLICY.md section recommending contributors scope AI-assisted changes with OpenSpec's propose/apply workflow before code gets written, wires the openspec-* skills into AGENTS.md's skill-routing table, and ignores `.agents/skills/openspec-*`/`.agents/commands/opsx/` since `openspec init` generates those locally and they must never be committed. See: #1002 (review) Assisted-by: Sisyphus:claude-sonnet-5 opencode
dd9fd5b to
7167b46
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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 @.github/AI_POLICY.md:
- Line 19: Update the OpenSpec workflow guidance in AI_POLICY.md to avoid
presenting “/opsx:propose” and “/opsx:apply” as universal syntax. Retain the
workflow intent while directing readers to the generated command configuration
or OpenSpec documentation, and clarify that command syntax depends on the AI
assistant.
In @.gitignore:
- Line 181: Update the comment describing OpenSpec-generated files to use the
correct tool name, replacing “openspec.ai” with “OpenSpec” or “openspec.dev”
while preserving the comment’s meaning.
🪄 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 Plus
Run ID: 18670abe-97c4-45fe-b1bb-40e25dfae2af
📒 Files selected for processing (2)
.github/AI_POLICY.md.gitignore
.github/AI_POLICY.md, .gitignore and AGENTS.md's openspec-* additions now live in #1005 (split out per the review at #1002 (review)), so this branch no longer needs to wait on #1000 or carry them. Assisted-by: Sisyphus:claude-sonnet-5 opencode
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR updates contributor-facing documentation and repository hygiene to encourage scoping AI-assisted work with OpenSpec before code is written, and to ensure OpenSpec-generated local agent assets are not accidentally committed.
Changes:
- Add an OpenSpec “Recommended tooling” section to
.github/AI_POLICY.mddescribing the propose/apply workflow. - Ignore locally generated OpenSpec agent skills/commands via
.gitignore. - Extend
AGENTS.md’s skill-routing table with OpenSpec-related entries.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
AGENTS.md |
Adds OpenSpec skill-routing entries so contributors know which skills to use for spec-driven scoping. |
.gitignore |
Ignores OpenSpec-generated .agents/... files to keep local-only assets out of commits. |
.github/AI_POLICY.md |
Recommends OpenSpec as a workflow tool for scoping AI-assisted changes before implementation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| If you're using an AI coding agent, install [OpenSpec](https://openspec.dev/) (`npm install -g @fission-ai/openspec@latest`, then `openspec init`) and use its spec-driven workflow (`/opsx:propose` → `/opsx:apply`) to scope the change into a reviewable proposal + spec + tasks *before* any code gets written. `openspec init` provisions the matching skills/commands locally — see [`AGENTS.md`](../AGENTS.md#skill-routing). | ||
|
|
||
| These skills are not installed in this repo — `.agents/skills/openspec-*`, and `.agents/commands/opsx/` are generated on your own machine by `openspec init` and must never be committed. Provision them locally, keep them out of your diffs and PRs. |
Put an
xinto the box if that apply:Description of your changes
What
This section was generated by AI.
.github/AI_POLICY.mdrecommending contributors scope AI-assisted changes with OpenSpec's propose/apply workflow before code gets written..agents/skills/openspec-*and.agents/commands/opsx/*to.gitignore, sinceopenspec initgenerates those locally per-contributor and they must never be committed.openspec-*skills intoAGENTS.md's skill-routing table - the skill files are gitignored/local-only, but the routing metadata is meant to stay in the shared repo.Why
How can we test changes
This section was generated by AI.
Read
.github/AI_POLICY.mdand.gitignore- no code/behavior change, documentation and ignore-rules only.Assisted-by
Specific models used per commit are specified in the commit messages.