Add AGENTS.md and CLAUDE.md to the project #1439
Conversation
|
🚀 Preview deployment available at: https://dcd4282f.rdoc-6cd.pages.dev (commit: 886b68d) |
|
|
||
| **Configuration:** `.rubocop.yml` | ||
|
|
||
| - Target Ruby: 3.0 |
There was a problem hiding this comment.
This kind of contradicts the other Ruby version requirement.
There was a problem hiding this comment.
It's simply stating the RuboCop uses Ruby 3.0's syntax to lint the code, which can affect the result. This IMO doesn't contradict with the fact that at runtime we have to make it compatible with Ruby 2.6.
| ## Common Workflows | ||
|
|
||
| Do NOT commit anything. Ask the developer to review the changes after tasks are finished. | ||
|
|
||
| NEVER pushes code to any repositories. |
There was a problem hiding this comment.
Are these necessary? Do we see agents trying to commit and push? 😨
There was a problem hiding this comment.
Yes this happened to me once due to testing a copy-pasted user-level command instruction 😅
And honestly, I want to make sure anyone contributing to RDoc using AI at least committing (and hopefully reviewing the code) by themselves.
st0012
force-pushed
the
add-ai-coding-agent-instructions
branch
from
f234e00 to
aeff50a
Compare
I've been using AI coding agents to assist my development in RDoc for a while. And having these instructions can save me (or anyone who wants to contribute) quite a bit of time.
AGENTS.mdis what most agentic tools use, such as OpenAI Codex or Cursor.CLAUDE.mdis only for Claude Code, which is the main tool I use.