docs: add CLAUDE.md and update README structure#6
Conversation
- Add CLAUDE.md with development commands and architecture overview - Fix README to reflect actual project structure (crates/tests instead of crates/e2e-tests) - Update test suite description to match current implementation 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
WalkthroughA new documentation file, Changes
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @tac0turtle, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request focuses on improving the project's documentation and ensuring the README accurately reflects the current project structure and testing setup. It introduces a new document specifically for Claude Code and corrects outdated information in the README.
Highlights
- Documentation: Added
CLAUDE.mdto provide guidance for Claude Code, including common development commands and a high-level architecture overview. - README Update: Corrected the README to accurately reflect the project structure, changing
crates/e2e-teststocrates/tests. - Test Suite Description: Updated the test suite description in the README to match the current implementation.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
julienrbrt
changed the title
There was a problem hiding this comment.
Code Review
This pull request introduces a CLAUDE.md file to guide AI-assisted development and updates the README.md to reflect changes in the test directory structure. The new documentation is comprehensive and largely accurate. My review includes suggestions to enhance the CLAUDE.md file by adding missing Docker commands and ensuring the file ends with a newline.
| ### Running the Node | ||
| - **Run with defaults**: `make run` | ||
| - **Run with debug logs**: `make run-dev` | ||
| - **Direct execution**: `./target/release/lumen node --chain <CHAIN_SPEC> --datadir <DATA_DIR> --http --ws` |
There was a problem hiding this comment.
The Makefile defines several useful Docker-related commands (docker-build, docker-build-push, etc.). It would be valuable to document these under a new ### Docker subsection within the "Common Development Commands" section.
| - **Direct execution**: `./target/release/lumen node --chain <CHAIN_SPEC> --datadir <DATA_DIR> --http --ws` | |
| ### Running the Node | |
| - **Run with defaults**: `make run` | |
| - **Run with debug logs**: `make run-dev` | |
| - **Direct execution**: `./target/release/lumen node --chain <CHAIN_SPEC> --datadir <DATA_DIR> --http --ws` | |
| ### Docker | |
| - **Build Docker image**: `make docker-build` | |
| - **Build and push Docker image**: `make docker-build-push` | |
| - **Build and push Docker image as latest**: `make docker-build-push-latest` |
| - Engine API interactions | ||
| - Payload building with transactions | ||
| - State execution validation | ||
| - Rollkit-specific scenarios No newline at end of file |
There was a problem hiding this comment.
It's a good practice to end files with a newline character. This can prevent issues with file concatenation and diffs.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
CLAUDE.md (1)
51-54: Minor grammar – add missing article “the”
Small wording tweak for smoother reading:-3. Payload builder executes transactions against current state +3. Payload builder executes transactions against the current state
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
CLAUDE.md(1 hunks)README.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
CLAUDE.md
[uncategorized] ~52-~52: You might be missing the article “the” here.
Context: ...d builder executes transactions against current state 4. Block is constructed and retur...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
⏰ Context from checks skipped due to timeout of 90000ms (8)
- GitHub Check: doc tests
- GitHub Check: test
- GitHub Check: e2e
- GitHub Check: test
- GitHub Check: clippy
- GitHub Check: docs
- GitHub Check: clippy
- GitHub Check: crate-checks
🔇 Additional comments (1)
README.md (1)
107-108: Ensure workspace paths & CI reflect thecrates/testsrenameThe docs now reference
crates/testsinstead ofcrates/e2e-tests.
Please double-check that:
- The root
Cargo.toml[workspace]members list and any CI scripts have been updated to the new path;- No stale references to
crates/e2e-testsremain elsewhere in the repo.A quick
rg crates/e2e-testsrun should confirm.Also applies to: 185-186
2 participants
🤖 Generated with Claude Code
Co-Authored-By: Claude noreply@anthropic.com## Description
Summary by CodeRabbit