Fix incorrect repository clone URL in README setup guide#571
Open
shrushtigaynar wants to merge 1 commit into
Open
Fix incorrect repository clone URL in README setup guide#571shrushtigaynar wants to merge 1 commit into
shrushtigaynar wants to merge 1 commit into
Conversation
✅ Deploy Preview for github-spy ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
🎉 Thank you @shrushtigaynar for your contribution. Please make sure your PR follows https://github.com/GitMetricsLab/github_tracker/blob/main/CONTRIBUTING.md#-pull-request-guidelines
Contributor
📝 WalkthroughWalkthroughThe README setup instructions are updated to use the correct GitMetricsLab repository URL when cloning, replacing a placeholder example URL with the actual project repository. ChangesSetup Instructions
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
README.md (2)
51-51:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winDirectory name mismatch with repository name.
The clone command on Line 46 will create a directory named
github_tracker(with underscore), but this command instructs users to navigate togithub-tracker(with hyphen), which won't exist.📂 Proposed fix to match the repository name
-$ cd github-tracker +$ cd github_tracker🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` at line 51, The README has a directory name mismatch: the earlier git clone creates "github_tracker" (underscore) but the later cd uses "github-tracker" (hyphen); update the cd command to use the same directory name created by the clone (replace "github-tracker" with "github_tracker") or alternatively change the clone target to "github-tracker" so both commands reference the exact same directory name ("github_tracker" vs "github-tracker") for consistency.
23-27:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winMake README GitHub references consistent (
GitMetricsLab/github_tracker)
- README badges (Lines 23-27) and the contributor link (Line 129) still point to
mehul-m-prajapati/github_tracker, while the clone URL usesGitMetricsLab/github_tracker(Line 46).- Update the remaining
mehul-m-prajapati/github_trackerURLs toGitMetricsLab/github_tracker(unless the difference is intentional and documented).🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 23 - 27, Replace all remaining occurrences of the repository path string "mehul-m-prajapati/github_tracker" in the README (notably the badge image URLs and the contributor link) with "GitMetricsLab/github_tracker" to make GitHub references consistent with the clone URL; search for the exact string "mehul-m-prajapati/github_tracker" and update each badge src and the contributor href to "GitMetricsLab/github_tracker", ensuring no other intentional references remain.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@README.md`:
- Line 51: The README has a directory name mismatch: the earlier git clone
creates "github_tracker" (underscore) but the later cd uses "github-tracker"
(hyphen); update the cd command to use the same directory name created by the
clone (replace "github-tracker" with "github_tracker") or alternatively change
the clone target to "github-tracker" so both commands reference the exact same
directory name ("github_tracker" vs "github-tracker") for consistency.
- Around line 23-27: Replace all remaining occurrences of the repository path
string "mehul-m-prajapati/github_tracker" in the README (notably the badge image
URLs and the contributor link) with "GitMetricsLab/github_tracker" to make
GitHub references consistent with the clone URL; search for the exact string
"mehul-m-prajapati/github_tracker" and update each badge src and the contributor
href to "GitMetricsLab/github_tracker", ensuring no other intentional references
remain.
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
1 participant
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.
Description
Updated the placeholder clone URL in the README setup guide with the correct repository URL.
Changes Made
Issue
Closes #569
Summary by CodeRabbit