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

Jump to bottom

docs: code formatting #20

Merged
merged 2 commits into from
Mar 23, 2024
Merged

docs: code formatting #20

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
230025b
docs: code formatting
gitcommitshow Mar 17, 2024
159330f
docs: readme formatting
gitcommitshow Mar 22, 2024
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
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,24 @@ Tools and stats for open-source communities

# 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

gitcommitshow marked this conversation as resolved.
Show resolved Hide resolved
## 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
Copy link
Contributor

Choose a reason for hiding this comment

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

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 contributors
Committable 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.

Suggested change
## 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
```

Comment on lines 5 to 28
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 [30-30]

Again, "Github" should be capitalized as "GitHub".

- Fetch data from Github APIs
+ Fetch data from GitHub APIs

The word "accout" is misspelled. It should be corrected to "account".

- organization/user accout
+ organization/user account

Expand All @@ -32,7 +32,7 @@ This will

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.

```
```bash
ock yourGitHubOrgName yourGitHubPersonalToken
```

Expand All @@ -52,8 +52,8 @@ OCK.contributors.github.archive(

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
Copy link
Contributor

Choose a reason for hiding this comment

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

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


```
```yaml
# Set these variables in the environment to avoid repeatedly specifying these variables
1. REPO_OWNER
2. GITHUB_PERSONAL_TOKEN
```
```
Loading