-
-
Notifications
You must be signed in to change notification settings - Fork 646
Update README example path #3315
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
base: main
Are you sure you want to change the base?
Conversation
Update wrong import path
|
@Poylar is attempting to deploy a commit to the shipshapecode Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughThe README documentation in the React package is updated to correct the import path example from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Tip 📝 Customizable high-level summaries are now available in beta!You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.
Example instruction:
Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later. Comment |
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)
packages/react/README.md (1)
3-3: Consider updating package references for consistency.The README now has conflicting package references:
- Line 3: NPM badge references
@shepherdpro/react- Line 5: GitHub link references
@shepherdpro/react- Lines 14 & 23: Install and import examples reference
react-shepherdAdditionally, the GitHub URL format on line 5 appears malformed (GitHub paths typically don't include
@in the URL path).While outside the immediate scope of this PR, updating these references to use the correct package name and valid repository URL would improve documentation consistency and prevent user confusion.
Could you verify the correct NPM package name and GitHub repository URL, and confirm whether these should be updated as part of this PR?
Also applies to: 5-5
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
packages/react/README.md(1 hunks)
🔇 Additional comments (1)
packages/react/README.md (1)
23-23: Import statement correctly updated.The import now matches the package name shown in the install command (
react-shepherd), resolving the inconsistency.
Update wrong import path
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.