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

readme: fix formatting #23

Merged
merged 2 commits into from
Mar 27, 2024
Merged

readme: fix formatting #23

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
82e307c
readme: fix formatting
gitcommitshow Mar 26, 2024
0a7c019
capitalise github brand name
gitcommitshow Mar 27, 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
17 changes: 11 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,23 @@ 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)

# 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

Comment on lines 3 to 25
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 [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

Expand All @@ -36,7 +39,7 @@ You will hit the API limits soon. **To increase API limits**, add [`GITHUB_PERSO
ock yourGitHubOrgName yourGitHubPersonalToken
```

### Using code
**Using code**

```javascript
import OCK from 'open-community-kit';
Expand All @@ -48,6 +51,8 @@ OCK.contributors.github.archive(
);
```

----

## 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
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 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 parameters
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
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

Expand Down
Loading