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: update ranking information #2749

Closed
wants to merge 4 commits into from
Closed

docs: update ranking information #2749

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a04a60b
docs: update ranking information
rickstaa May 26, 2023
d88a1b1
Update readme.md
rickstaa May 26, 2023
89852f1
docs: add rank circle documentation
rickstaa May 30, 2023
46bed01
docs: add grading system reference
rickstaa May 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion readme.md
View file
Open in desktop
Expand Up @@ -108,7 +108,7 @@ Change the `?username=` value to your GitHub username.
```

> **Note**
> Available ranks are S+ (top 1%), S (top 25%), A++ (top 45%), A+ (top 60%), and B+ (everyone). The values are calculated by using the [cumulative distribution function](https://en.wikipedia.org/wiki/Cumulative_distribution_function) using commits, contributions, issues, stars, pull requests, followers, and owned repositories. The implementation can be investigated at [src/calculateRank.js](./src/calculateRank.js).
> Available ranks are S+ (top 2.5%), S (top 10%), A+ (top 25%), A (top 50%), B+ (top 75%) and B (everyone). This ranking scheme is based on the [Japanese Academic Grading system](https://en.wikipedia.org/wiki/Academic_grading_in_Japan). It is calculated as a weighted sum of ranks for each statistic (number of commits, pull requests, issues, stars and followers) based on the cumulative distribution function of an [exponential distribution](https://wikipedia.org/wiki/exponential_distribution). The implementation can be investigated at [src/calculateRank.js](./src/calculateRank.js). The circle around the rank shows the rank completion percentage compared to the maximum rank.

### Hiding individual stats

Expand Down