Add text file for coding LLMs with high-level nwaku info and style guide advice #3624
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fryorcraken
reviewed
Oct 20, 2025
Collaborator
There was a problem hiding this comment.
Is there a more generic name than CLAUDE.md we can use? Just wondering, I do know most LLM just check all the potential files (COPILOT.md etc). I assume we did not land on any standard yet?
Contributor
Author
There was a problem hiding this comment.
I agree that we should not link out naming to one particular LLM provider, but I haven't been able to find an obvious generic alternative. Potential options: AI-CODING-GUIDE.md, CONTRIBUTING-AI.md, DEVELOPMENT-AI.md, AI.md.
Collaborator
There was a problem hiding this comment.
I believe AGENTS.md 's support is growing.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a file with high-level project info, structure, naming and style conventions for helping AI coding assistants.
Changes
Add CLAUDE.md file with the above info, compiled with the help of AI from nwaku codebase and the Nim style guide.
Issue
closes #