Skip to content

docs: fix README test directory path - #32

Open
piyushbag wants to merge 1 commit into
maple-labs:mainfrom
piyushbag:fix/31-readme-test-path
Open

docs: fix README test directory path#32
piyushbag wants to merge 1 commit into
maple-labs:mainfrom
piyushbag:fix/31-readme-test-path

Conversation

@piyushbag

@piyushbag piyushbag commented Jul 21, 2026

Copy link
Copy Markdown

Summary

  • Correct README make test description to reference tests/

Test plan

  • Documentation-only change
  • forge test --match-path tests/invariants/BasicInvariants.t.sol --no-match-test invariant

Summary by CodeRabbit

  • Documentation
    • Updated the README’s test command documentation to accurately reflect the current test location.

The integration test suite lives under tests/, not contracts/tests/.

Fixes maple-labs#31
@piyushbag
piyushbag requested a review from a team as a code owner July 21, 2026 18:03
@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 295de4d6-7b3f-419a-a1c1-dd815a62879f

📥 Commits

Reviewing files that changed from the base of the PR and between f59f30c and bf60b76.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

The README updates the make test command documentation to reference tests in tests/ instead of contracts/tests/.

Changes

Test command documentation

Layer / File(s) Summary
Update documented test directory
README.md
The make test description now references the root tests/ directory.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related issues

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the README documentation fix for the test directory path.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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.

1 participant