Skip to content

docs: add CLAUDE.md and Agents.md for AI coding assistant guidance#5437

Open
akrem-chabchoub wants to merge 16 commits intomasterfrom
feat/agents
Open

docs: add CLAUDE.md and Agents.md for AI coding assistant guidance#5437
akrem-chabchoub wants to merge 16 commits intomasterfrom
feat/agents

Conversation

@akrem-chabchoub
Copy link
Copy Markdown
Contributor

@akrem-chabchoub akrem-chabchoub commented Apr 15, 2026

Checklist

  • I have read the coding guide.
  • My change requires a documentation update, and I have done it.
  • I have added tests to cover my changes.
  • I have filled out the description and linked the related issues.

Description

Add Agents.md and CLAUDE.md to help ai agents understood better the code

Open API Spec Version Changes (if applicable)

Motivation and Context (Optional)

Related Issue (Optional)

#5407

Screenshots (if appropriate):

AI Disclosure

  • This PR contains code that has been generated by an LLM.
  • I have reviewed the AI generated code thoroughly.
  • I possess the technical expertise to responsibly review the code generated in this PR.

@akrem-chabchoub akrem-chabchoub changed the title Feat/agents docs: add CLAUDE.md for AI coding assistant guidance Apr 15, 2026
@akrem-chabchoub akrem-chabchoub self-assigned this Apr 15, 2026
@akrem-chabchoub akrem-chabchoub marked this pull request as ready for review April 15, 2026 13:29
@akrem-chabchoub akrem-chabchoub added this to the 2026 milestone Apr 15, 2026
@akrem-chabchoub akrem-chabchoub linked an issue Apr 15, 2026 that may be closed by this pull request
@akrem-chabchoub akrem-chabchoub changed the title docs: add CLAUDE.md for AI coding assistant guidance docs: add CLAUDE.md and Agents.md for AI coding assistant guidance Apr 15, 2026
Comment thread AGENTS.md
- `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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we go even deeper with db repair and db nuke?

Copy link
Copy Markdown
Contributor Author

@akrem-chabchoub akrem-chabchoub Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it can be added, but the frequency of use is unclear. If it is not needed too often, it remains practical. When required, the agent can execute bee db to retrieve the information.

AFAIK, these files are meant to serve as a map for agents rather than a fully detailed manual.

image

Copy link
Copy Markdown
Member

@gacevicljubisa gacevicljubisa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@akrem-chabchoub
Copy link
Copy Markdown
Contributor Author

@gacevicljubisa

  • adding refs to CODING.md, CODINGSTYLE.md, CONTRIBUTING.md

It is already there

  • minimal, focused changes

I will add it

  • do not add, remove, or update dependencies

Maybe we can say unless I explicitly mention ?

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.

I will remove unnecessary ones and add commits msg format.

Thanks !

Copy link
Copy Markdown
Member

@gacevicljubisa gacevicljubisa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, maybe it would be good to add CLAUDE.md with short disclosure that instructions are in AGENT.md?

Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
@akrem-chabchoub akrem-chabchoub requested a review from acud May 8, 2026 16:01
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md

## Pre-commit checklist

Before you finish a change set (especially before a commit or PR), run these and fix failures:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes good idea I agree

Copy link
Copy Markdown
Contributor

@acud acud left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@akrem-chabchoub akrem-chabchoub force-pushed the feat/agents branch 2 times, most recently from 38fe3ef to a0e2e64 Compare May 8, 2026 19:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add CLAUDE.md / AGENTS.md for AI coding assistant context

4 participants