feat: add Agents.MD and openspec support #237
Conversation
✅ Deploy Preview for hoppdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Caution Review failedThe pull request is closed. 📝 WalkthroughWalkthroughAdds OpenSpec workflow and agent development documentation, plus project context and a gitignore entry to exclude generated OpenSpec changes. All changes are new documentation files; no exported/public code signatures were modified. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In @.gitignore:
- Around line 29-31: The .gitignore currently excludes the openspec/changes
directory which prevents versioning of OpenSpec proposals and docs; remove the
"openspec/changes" entry from .gitignore so that files placed under
openspec/changes/<id>/ are tracked, reviewed, and can be archived later,
ensuring the OpenSpec workflow in openspec/AGENTS.md and
.cursor/commands/openspec-proposal.md works correctly; after removal, run git
add on any existing openspec/changes content and commit to start tracking those
artifacts.
| .yarn/install-state.gz | ||
|
|
||
| openspec/changes No newline at end of file |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# First, let's explore the repository structure to understand the context
git ls-files | head -20Repository: gethopp/hopp
Length of output: 641
🏁 Script executed:
# Look for OpenSpec-related files and documentation
fd -t f "openspec" -o "OPENSPEC" -o "openspec" | head -20Repository: gethopp/hopp
Length of output: 191
🏁 Script executed:
# Check for documentation files that might mention OpenSpec
fd -t f "README|readme|DOCS|docs|openspec" | grep -i "openspec\|spec\|change" | head -20Repository: gethopp/hopp
Length of output: 38
🏁 Script executed:
# Examine the openspec directory structure if it exists
find . -type d -name "openspec" 2>/dev/null | head -5Repository: gethopp/hopp
Length of output: 66
🏁 Script executed:
# Look at the .gitignore file in context to understand the changes
cat -n .gitignore | tail -20Repository: gethopp/hopp
Length of output: 396
🏁 Script executed:
# Examine the openspec directory structure
ls -la openspec/ 2>/dev/null || echo "Directory not found"Repository: gethopp/hopp
Length of output: 294
🏁 Script executed:
# Look for openspec documentation files
find ./openspec -type f 2>/dev/null | head -20Repository: gethopp/hopp
Length of output: 98
🏁 Script executed:
# Check the OpenSpec cursor commands for context about proposals
cat .cursor/commands/openspec-proposal.mdRepository: gethopp/hopp
Length of output: 2585
🏁 Script executed:
# Check if there's any README or documentation in openspec
find ./openspec -name "README*" -o -name "readme*" -o -name "*.md" 2>/dev/nullRepository: gethopp/hopp
Length of output: 98
🏁 Script executed:
# Look at git history to understand when openspec/changes was added to gitignore
git log --oneline -n 20 -- .gitignore 2>/dev/null | head -20Repository: gethopp/hopp
Length of output: 104
🏁 Script executed:
# Read the OpenSpec project documentation to understand the intended workflow
cat openspec/project.mdRepository: gethopp/hopp
Length of output: 6310
🏁 Script executed:
# Check the AGENTS.md for OpenSpec conventions
cat openspec/AGENTS.md | head -100Repository: gethopp/hopp
Length of output: 4512
🏁 Script executed:
# Look for any existing openspec/changes directory content
find ./openspec/changes -type f 2>/dev/null | head -20Repository: gethopp/hopp
Length of output: 38
🏁 Script executed:
# Check git status to see if openspec/changes is being ignored
git status --ignored openspec/ 2>/dev/nullRepository: gethopp/hopp
Length of output: 121
Remove openspec/changes from .gitignore.
The OpenSpec workflow documented in openspec/AGENTS.md and .cursor/commands/openspec-proposal.md explicitly instructs creating and storing change proposals, tasks, and design documents in openspec/changes/<id>/. These artifacts are meant to be versioned, reviewed, and later archived to openspec/changes/archive/ after deployment. Ignoring this directory prevents the entire spec-driven development workflow from being tracked in version control.
Suggested fix
- openspec/changes🤖 Prompt for AI Agents
In @.gitignore around lines 29 - 31, The .gitignore currently excludes the
openspec/changes directory which prevents versioning of OpenSpec proposals and
docs; remove the "openspec/changes" entry from .gitignore so that files placed
under openspec/changes/<id>/ are tracked, reviewed, and can be archived later,
ensuring the OpenSpec workflow in openspec/AGENTS.md and
.cursor/commands/openspec-proposal.md works correctly; after removal, run git
add on any existing openspec/changes content and commit to start tracking those
artifacts.
Add basic
AGENTS.mdinside the repo, and basic support for open-spec.AGENTS.mdwill stay in the repo, regardless of the removal of open-spec, and its up to us to update accordingly and keep it up-to-date.Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.