-
Notifications
You must be signed in to change notification settings - Fork 808
Add CLAUDE.md for Claude Code guidance #10345
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
Any thoughts about the more generic AGENTS.md? I'm not sure how standardised this area is as my hobby projects have ended up with |
|
I have no opinion on the matter, more generic is better. I guess we could (lol) ask the LLMs what the consensus is? |
|
There is something else we (me?) failed to document. But you can use |
|
There doesn't seem to be a consensus way to do this yet, the other tools seem to also parse CLAUDE.md (and various other files). I'd say let's merge this and add mise into a more general file in docs/ that is linked from CLAUDE.md also? We can also extract more stuff into docs/building.md etc, if we want. The bigger question is, do we want this in the repo to help save tokens amongs users of Claude? |
|
Olivier and I discussed this. We don't mind an This PR needs a rebase so that only the newly added file shows up in the diff. |
tronical
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(GH requires a comment when giving a review)
|
It's the root or not at all. Part of requesting 'AGENTS' instead of CLUADE was too minimise it to a single file and not one for each flavour of the month LLM. |
|
Yep, top-level (root) is fine with Olivier and me. Whatever works :) |
Provides build commands, testing instructions, architecture overview, and platform prerequisites to help Claude Code navigate the repository.
- Rename header from CLAUDE.md to AGENTS.md - Add missing internal components (core-macros, common) - Add missing backends (selector, testing) - Add missing tools (slintpad, figma_import, tr-extractor, updater) - Add wasm-interpreter API - Add new Editor Support section with all editor integrations
e09d541 to
d75eb90
Compare
Co-authored-by: Simon Hausmann <[email protected]>
Provides build commands, testing instructions, architecture overview, and platform prerequisites to help Claude Code navigate the repository.