docs: add CLAUDE.md and Agents.md for AI coding assistant guidance#5437
docs: add CLAUDE.md and Agents.md for AI coding assistant guidance#5437akrem-chabchoub wants to merge 16 commits intomasterfrom
Conversation
| - `bee start` — full or light node (`cmd/bee/cmd/start.go`) | ||
| - `bee init` — initialize data directory | ||
| - `bee deploy` — deploy smart contracts | ||
| - `bee db` — database management |
There was a problem hiding this comment.
Should we go even deeper with db repair and db nuke?
There was a problem hiding this comment.
gacevicljubisa
left a comment
There was a problem hiding this comment.
Claude Code should read AGENTS.md as fallback. So, no need to have both.
I would focsu on the code Guidelines like:
- adding refs to CODING.md, CODINGSTYLE.md, CONTRIBUTING.md
- minimal, focused changes
- do not add, remove, or update dependencies
- error handling
- testing
- loging
Regarding make targets, I would include only necesary during dev proces.
There is no need to start actual bee node using agents.
Additionally commit msg format can be included.
Maybe this can serve as example https://github.com/ethereum/go-ethereum/blob/master/AGENTS.md wit
It is already there
I will add it
Maybe we can say unless I explicitly mention ?
I will remove unnecessary ones and add commits msg format. Thanks ! |
gacevicljubisa
left a comment
There was a problem hiding this comment.
Also, maybe it would be good to add CLAUDE.md with short disclosure that instructions are in AGENT.md?
|
|
||
| ## Pre-commit checklist | ||
|
|
||
| Before you finish a change set (especially before a commit or PR), run these and fix failures: |
There was a problem hiding this comment.
this is just my preference, but i honestly am very averse to claude touching my git history. in most of my projects there's a big fat line saying - never commit anything to git. NEVER!!!. it makes things very difficult to follow since the agents add a lot of intermediate commits - i like to have my own messages and history that i as an operator can relate to.
that being said, i don't have much resistance to having this committed as it is, but i would strongly suggest to add both of these files to the .gitignore file, so that devs can be free to make their own changes locally, and we can just keep the "spine" of the document in the repo, with little changes as needed
There was a problem hiding this comment.
Yes good idea I agree
acud
left a comment
There was a problem hiding this comment.
LGTM, just please add now these files to the repos .gitignore as part of this changeset before merging, as this will just be more convenient for devs using this inadvertently
38fe3ef to
a0e2e64
Compare
Made-with: Cursor
a0e2e64 to
8f54535
Compare

Checklist
Description
Add
Agents.mdandCLAUDE.mdto help ai agents understood better the codeOpen API Spec Version Changes (if applicable)
Motivation and Context (Optional)
Related Issue (Optional)
#5407
Screenshots (if appropriate):
AI Disclosure