Skip to content
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.

Sign up for GitHub

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

docs: Update README.md #19

Merged
merged 1 commit into from
Mar 22, 2024
Merged

docs: Update README.md #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# open-community-kit
# open-community-kit (ock)
Tools and stats for open-source communities

[![test](https://github.com/gitcommitshow/open-community-kit/actions/workflows/test.yml/badge.svg)](https://github.com/gitcommitshow/open-community-kit/actions/workflows/test.yml)
Comment on lines +1 to 4
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [16-16]

The mention of "github" should adhere to the official capitalization as "GitHub". This ensures consistency and respects the brand's official naming convention.

- Create a leaderboard of github contributors
+ Create a leaderboard of GitHub contributors

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [23-23]

There's a typographical error in "open-commmunity-kit" (an extra 'm'). Correct spelling enhances readability and professionalism in documentation.

- open-commmunity-kit
+ open-community-kit

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [30-30]

Again, "Github" should be corrected to "GitHub" for consistency with the official platform name.

- 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 [30-30]

The word "accout" is a typo and should be corrected to "account" to avoid confusion and maintain professionalism in the documentation.

- organization/user accout
+ organization/user account

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [39-39]

There's an unnecessary space before the closing parenthesis in the JavaScript code example. Removing this space adheres to standard coding practices and improves code readability.

- 'your_gh_personal_token_optional'     } );
+ 'your_gh_personal_token_optional'     });

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [53-53]

The phrase "set following environment variables" is missing an article. Adding "the" before "following" improves the grammatical correctness of the sentence.

- you can set following environment variables
+ you can set the following environment variables

Additionally, consider adding a comma before "and then" for better readability and to adhere to grammatical best practices.

- variables and then you don't need
+ variables, and then you don't need

Expand Down Expand Up @@ -56,4 +56,4 @@ If you are going to use this command frequently, you might not want to set organ
# Set these variables in the environment to avoid repeatedly specifying these variables
1. REPO_OWNER
2. GITHUB_PERSONAL_TOKEN
```
```
Loading