-
Notifications
You must be signed in to change notification settings - Fork 12.1k
fix(docs): correct filename punctuation in README installation instructions #5907
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
|
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis PR refines the installation instructions in README.md by adjusting the placement of the period relative to the backticked filename so users can copy-paste the filename accurately. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughUpdated README.md to correct an installation instruction, changing a file reference from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
✨ Finishing Touches🧪 Generate 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
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.
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.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
45-45
: Nit: Prefer “to” over “in” for idiomatic phrasingSlightly clearer instruction.
-Add `@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/` in `remappings.txt`. +Add `@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/` to `remappings.txt`.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md
(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: halmos
- GitHub Check: tests-foundry
- GitHub Check: coverage
- GitHub Check: slither
- GitHub Check: tests
🔇 Additional comments (1)
README.md (1)
45-45
: LGTM — filename punctuation fixed correctlyThe period is now outside the inline code span, so copy-paste of
remappings.txt
won't include it.
Remove period from within filename
remappings.txt
in Foundry installation instructions. The period should be part of the sentence structure, not the filename itself, ensuring accurate copy-paste instructions for users.PR Checklist
npx changeset add
)Summary by Sourcery
Documentation:
remappings.txt
code quote in the Foundry installation instructionsSummary by CodeRabbit