docs: code formatting #20
Conversation
WalkthroughThe update enriches the 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 (
|
|
LGTM |
![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: 5
Configuration used: CodeRabbit UI
Files selected for processing (1)
- README.md (2 hunks)
Additional comments: 1
README.md (1)
- 12-12: The addition of backticks around
npximproves the readability and consistency of the documentation. This change clearly distinguishes commands from regular text, which is beneficial for users.
There was a problem hiding this comment.
Review Status
Actionable comments generated: 3
Configuration used: CodeRabbit UI
Files selected for processing (1)
- README.md (3 hunks)
Additional comments: 1
README.md (1)
- 12-12: The backticks around
npximprove readability and consistency in the documentation. This is a good practice for highlighting commands or code snippets in markdown files.
|
|
||
| # Usage | ||
|
|
||
| ## Create a leaderboard of github contributors for all the repos of a user/org | ||
| ## Create a leaderboard of Github contributors for all the repos of a user/org |
There was a problem hiding this comment.
The term "Github" should be capitalized as "GitHub" to adhere to the official spelling of the platform.
- Create a leaderboard of Github contributors
+ Create a leaderboard of GitHub contributorsCommittable 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.
| ## Create a leaderboard of Github contributors for all the repos of a user/org | |
| ## Create a leaderboard of GitHub contributors for all the repos of a user/org |
|
|
||
| # Installation | ||
|
|
||
| ``` | ||
| ```bash | ||
| npm install -g open-community-kit | ||
| ``` | ||
|
|
||
| You can use npx as well if you just want to test a CLI command | ||
| You can use `npx` as well if you just want to test a CLI command | ||
|
|
||
| # Usage | ||
|
|
||
| ## Create a leaderboard of github contributors for all the repos of a user/org | ||
| ## Create a leaderboard of Github contributors for all the repos of a user/org | ||
| (Contributor with highest # of contributions at the top) | ||
|
|
||
| ### Using CLI | ||
|
|
||
| Run `open-community-kit yourGithubOrgName` from your terminal | ||
|
|
||
| Note: You can also use the shorthand `ock` in place of `open-commmunity-kit` i.e. | ||
| Note: You can also use the shorthand `ock` in place of `open-community-kit` i.e. | ||
|
|
||
| ``` | ||
| ```bash | ||
| ock yourGitHubOrgName | ||
| ``` | ||
|
|
There was a problem hiding this comment.
📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [30-30]
Again, "Github" should be capitalized as "GitHub".
- Fetch data from Github APIs
+ Fetch data from GitHub APIsThe word "accout" is misspelled. It should be corrected to "account".
- organization/user accout
+ organization/user account| @@ -52,8 +52,8 @@ | |||
|
|
|||
| If you are going to use this command frequently, you might not want to set organization name and personal token again and again. Instead, you can set following environment variables and then you don't need to pass those variables as CLI arguments or function parameters | |||
There was a problem hiding this comment.
Consider adding the article "the" before "organization name" and using a comma before "and then" for better readability.
- you might not want to set organization name and personal token again and again.
+ you might not want to set the organization name, and personal token again and again.Also, it's clearer to say "the following environment variables" instead of "following environment variables".
- you can set following environment variables and then you don't need to pass those variables
+ you can set the following environment variables, and then you don't need to pass those variables
Summary by CodeRabbit