readme: fix typo #25
readme: fix typo #25
Conversation
WalkthroughThis update addresses a minor but crucial typo in the project documentation. Specifically, it corrects a misspelling in the README.md file, enhancing the clarity of instructions related to utilizing GitHub APIs for the creation of a contributor leaderboard. The amendment transforms "user accout" into the correct "user account," ensuring accurate guidance for users. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 2
Configuration used: CodeRabbit UI
Files selected for processing (1)
- README.md (1 hunks)
Additional comments: 1
README.md (1)
- 33-33: The correction from "user accout" to "user account" is accurate and improves the document's clarity.
| @@ -30,7 +30,7 @@ ock yourGitHubOrgName | |||
| ``` | |||
|
|
|||
| This will | |||
| * Fetch data from Github APIs and prepare a leaderboard of all the contributors to public repositories of your GitHub organization/user accout | |||
| * Fetch data from Github APIs and prepare a leaderboard of all the contributors to public repositories of your GitHub organization/user account | |||
There was a problem hiding this comment.
The official name of GitHub should be capitalized. Please correct "Github" to "GitHub."
- Fetch data from Github APIs
+ Fetch data from GitHub APIsCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * Fetch data from Github APIs and prepare a leaderboard of all the contributors to public repositories of your GitHub organization/user account | |
| * Fetch data from GitHub APIs and prepare a leaderboard of all the contributors to public repositories of your GitHub organization/user account |
| ``` | ||
|
|
||
| This will | ||
| * Fetch data from Github APIs and prepare a leaderboard of all the contributors to public repositories of your GitHub organization/user accout | ||
| * Fetch data from Github APIs and prepare a leaderboard of all the contributors to public repositories of your GitHub organization/user account | ||
| * Save the leaderboard in a csv file in the same folder | ||
|
|
||
| You will hit the API limits soon. **To increase API limits**, add [`GITHUB_PERSONAL_TOKEN`](https://github.com/settings/tokens) as well in the arguments i.e. |
There was a problem hiding this comment.
📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [58-58]
Consider adding an article before "following" and a comma before "and" for better readability.
- you can set following environment variables and then you don't need to
+ you can set the following environment variables, and then you don't need to
Summary by CodeRabbit