readme: fix formatting #23
Conversation
WalkthroughThe recent update brings a fresh look to the README, enhancing readability and user guidance. Key improvements include a more intuitive structure, clearer instructions, and visual distinctions for different types of usage. Additionally, it introduces helpful tips on environment setup for users seeking a more streamlined experience. 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: 1
Configuration used: CodeRabbit UI
Files selected for processing (1)
- README.md (3 hunks)
Additional comments: 5
README.md (5)
- 3-25: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1-1]
The project name "open-community-kit" is correctly spelled, but consider capitalizing "Open Community Kit" when referring to it in the text for consistency and to match the formal naming convention.
- 6-6: The change to the section headers from
#to##improves the document's hierarchical structure. This change is consistent with the PR's objectives and enhances readability.- 3-25: > 📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [22-42]
The instructions for CLI usage are clear and concise. However, consider adding a brief explanation about what a "GitHub Personal Token" is and why it might be necessary for users unfamiliar with GitHub's API rate limits.
- 42-42: The "Using code" section provides a clear example of how to use the package programmatically. Ensure that the provided code snippet is tested and works as expected.
- 54-54: The guidance on setting environment variables for repeated usage is a valuable addition. It might be helpful to include examples of how to set these variables in different operating systems (e.g., Windows, macOS, Linux) for users who may be unfamiliar with the process.
|
LGTM |
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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: 6
README.md (6)
- 6-6: The installation instructions are clear and concise.
- 16-16: The usage section header has been appropriately updated to enhance document structure.
- 18-18: Corrected the capitalization for "GitHub" in the section header, aligning with the official naming convention.
- 22-22: The CLI usage instructions are clear and provide a good example of how to use the tool.
- 42-42: The code usage instructions are well-structured and provide clear guidance on how to use the library programmatically.
- 54-54: The guidance on setting environment variables for repeated usage is a valuable addition for users who frequently use the tool.
|
|
||
| [](https://github.com/gitcommitshow/open-community-kit/actions/workflows/test.yml) | ||
|
|
||
| # Installation | ||
| ## Installation | ||
|
|
||
| ```bash | ||
| npm install -g open-community-kit | ||
| ``` | ||
|
|
||
| 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 | ||
| (Contributor with highest # of contributions at the top) | ||
| ## Usage | ||
|
|
||
| ### Using CLI | ||
| ### Leaderboard - 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 | ||
|
|
There was a problem hiding this comment.
📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [33-33]
The spelling of "GitHub" should be corrected to use a capital "H" to adhere to the official naming convention.
- Fetch data from Github APIs
+ Fetch data from GitHub APIs📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [33-33]
There's a typo in "account". It should be corrected for clarity.
- organization/user accout
+ organization/user account| @@ -48,6 +51,8 @@ | |||
| ); | |||
| ``` | |||
|
|
|||
| ---- | |||
|
|
|||
| ## Settings for repeated usage | |||
|
|
|||
| 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 missing article "the" before "organization name" and "the" before "following environment variables" for grammatical correctness. Also, a comma before "and then" could improve readability.
- 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
+ you might not want to set the organization name and personal token again and again. Instead, you can set the following environment variables, and then you don't need to pass those variables as CLI arguments or function parametersCommittable 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.
| 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 | |
| If you are going to use this command frequently, you might not want to set the organization name and personal token again and again. Instead, you can set the following environment variables, and then you don't need to pass those variables as CLI arguments or function parameters |
Summary by CodeRabbit