chore: claude.md and a skill for writing integration tests#1141
Merged
Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 📝 WalkthroughWalkthroughTwo documentation files were added/expanded: a new integration-testing skill guide for Irys at .claude/skills/writing-integration-tests/SKILL.md, and an expanded CLAUDE.md with build/development commands, architecture overview, and testing/git conventions. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes 🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@CLAUDE.md`:
- Around line 16-20: The fenced code block after the "Run a single test:" line
in CLAUDE.md is missing a blank line; insert a single blank line between the
paragraph "Run a single test:" and the opening triple-backticks (```) so the
code block renders correctly across Markdown parsers, leaving the existing
contents unchanged.
- Around line 46-55: Add a language identifier to the fenced code block under
the "### Crate Dependency Layers" heading so markdown linters and syntax
highlighters treat it as plain text; locate the triple-backtick block that
contains the Foundation/Domain/Services/etc. lines and change the opening fence
from ``` to ```text (or ```plaintext) to explicitly specify the language.
Comment on lines
+16
to
+20
| Run a single test: | ||
| ```sh | ||
| cargo nextest run -p irys-actors test_name | ||
| cargo test -p irys-actors test_name # alternative without nextest | ||
| ``` |
Contributor
There was a problem hiding this comment.
Add blank line before fenced code block.
Markdown best practice requires blank lines around fenced code blocks for consistent rendering across different parsers.
📝 Proposed fix
Run a single test:
+
```sh
cargo nextest run -p irys-actors test_name
cargo test -p irys-actors test_name # alternative without nextest🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 17-17: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
🤖 Prompt for AI Agents
In `@CLAUDE.md` around lines 16 - 20, The fenced code block after the "Run a
single test:" line in CLAUDE.md is missing a blank line; insert a single blank
line between the paragraph "Run a single test:" and the opening triple-backticks
(```) so the code block renders correctly across Markdown parsers, leaving the
existing contents unchanged.
Comment on lines
+46
to
+55
| ### Crate Dependency Layers | ||
|
|
||
| ``` | ||
| Foundation: irys-types, irys-config, irys-database | ||
| Domain: irys-domain (BlockTree, BlockIndex, StorageModule, SupplyState) | ||
| Services: irys-actors (all services), irys-p2p, irys-api-server (actix-web) | ||
| Integration: irys-reth + irys-reth-node-bridge (EVM via Reth fork) | ||
| Subsystems: irys-packing, irys-packing-worker, irys-storage, irys-vdf | ||
| Utilities: irys-utils, irys-testing-utils, irys-cli, xtask | ||
| ``` |
Contributor
There was a problem hiding this comment.
Specify language for fenced code block.
The dependency diagram code block should specify a language identifier (e.g., text or plaintext) for proper syntax highlighting and markdown linting compliance.
📝 Proposed fix
### Crate Dependency Layers
-```
+```text
Foundation: irys-types, irys-config, irys-database
Domain: irys-domain (BlockTree, BlockIndex, StorageModule, SupplyState)🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 48-48: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In `@CLAUDE.md` around lines 46 - 55, Add a language identifier to the fenced code
block under the "### Crate Dependency Layers" heading so markdown linters and
syntax highlighters treat it as plain text; locate the triple-backtick block
that contains the Foundation/Domain/Services/etc. lines and change the opening
fence from ``` to ```text (or ```plaintext) to explicitly specify the language.
JesseTheRobot
approved these changes
Feb 16, 2026
JesseTheRobot
left a comment
Member
There was a problem hiding this comment.
One minor change, otherwise LGTM
This was referenced Feb 23, 2026
Merged
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Describe the changes
Checklist
Summary by CodeRabbit