feat: add 'progress' rank icon

[rickstaa]

This pull request allows users to replace the rank level with the rank progress by setting the rank_icon query to progress.

Preview

![Anurag's GitHub stats](https://github-readme-stats-git-addprogressrankicon-rickstaa.vercel.app/api?username=anuraghazra\&rank_icon=progress)

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
github-readme-stats	✅ Ready (Inspect)	Visit Preview	Jun 19, 2023 9:10am

[rickstaa]

@qwerty541, I'm curious to know what you think about the text size and whether a space should be put between the number and the % sign 🤔?

[qwerty541]

@qwerty541, I'm curious to know what you think about the text size and whether a space should be put between the number and the % sign thinking?

I think that it looks nice right now.

[silverwind]

https://github.com/silverwind updated, thanks.

[web-dev-sam]

A bit too late for this PR but there is still a major UX issue. If I were to visit someone's profile and it just says 80% how would they know what that even means? Maybe one could add something like "Top" above the percentage to for example indicate that they perform better than 80% in some way. (If that is what that means, I'm just guessing)

[rickstaa]

A bit too late for this PR but there is still a major UX issue. If I were to visit someone's profile and it just says 80% how would they know what that even means? Maybe one could add something like "Top" above the percentage to for example indicate that they perform better than 80% in some way. (If that is what that means, I'm just guessing)

Good point. Progress is how far along a user is compared to the highest possible score. It is the inverse of the percentage explained in the documentation:

Available ranks are S (top 1%), A+ (12.5%), A (25%), A- (37.5%), B+ (50%), B (62.5%), B- (75%), C+ (87.5%) and C (everyone). This ranking scheme is based on the Japanese academic grading system. The global percentile is calculated as a weighted sum of percentiles for each statistic (number of commits, pull requests, issues, stars and followers), based on the cumulative distribution function of the exponential and the log-normal distributions. The implementation can be investigated at src/calculateRank.js. The circle around the rank shows 100 minus the global percentile.

We can change it to equal the top percentages in the documentation. In @silverwind's case, it would be top 0.9%. Do you think this is more clear?

![Anurag's GitHub stats](https://github-readme-stats-git-addprogressrankicon-rickstaa.vercel.app/api?username=silverwind&rank_icon=progress)

[rickstaa]

A bit too late for this PR but there is still a major UX issue. If I were to visit someone's profile and it just says 80% how would they know what that even means? Maybe one could add something like "Top" above the percentage to for example indicate that they perform better than 80% in some way. (If that is what that means, I'm just guessing)

Good point. Progress is how far along a user is compared to the highest possible score. It is the inverse of the percentage explained in the documentation:

Available ranks are S (top 1%), A+ (12.5%), A (25%), A- (37.5%), B+ (50%), B (62.5%), B- (75%), C+ (87.5%) and C (everyone). This ranking scheme is based on the Japanese academic grading system. The global percentile is calculated as a weighted sum of percentiles for each statistic (number of commits, pull requests, issues, stars and followers), based on the cumulative distribution function of the exponential and the log-normal distributions. The implementation can be investigated at src/calculateRank.js. The circle around the rank shows 100 minus the global percentile.

We can change it to equal the top percentages in the documentation. In @silverwind's case, it would be top 0.9%. Do you think this is more clear?

![Anurag's GitHub stats](https://github-readme-stats-git-addprogressrankicon-rickstaa.vercel.app/api?username=silverwind&rank_icon=progress)

@qwerty541 do you agree that top % makes more sense, or do you think it is better to update the documentation?

[web-dev-sam]

I personally think the top percentage (for example top 0.9% instead of 99.1%) is better as it carries more meaning. You cant compare yourself against numbers without units/meaning or with too complicated units/meaning. A top percentage is an easy and intuitive metric.

[rickstaa]

I personally think the top percentage (for example top 0.9% instead of 99.1%) is better as it carries more meaning. You cant compare yourself against numbers without units/meaning or with too complicated units/meaning. A top percentage is an easy and intuitive metric.

Does #2859 suit your need?

[![Anurag's GitHub stats](https://github-readme-stats-git-addpercentilerankicon-rickstaa.vercel.app//api?username=mindlabordev&rank_icon=percentile)](https://github.com/anuraghazra/github-readme-stats)

[web-dev-sam]

I personally think the top percentage (for example top 0.9% instead of 99.1%) is better as it carries more meaning. You cant compare yourself against numbers without units/meaning or with too complicated units/meaning. A top percentage is an easy and intuitive metric.

Does #2859 suit your need?

[![Anurag's GitHub stats](https://github-readme-stats-git-addpercentilerankicon-rickstaa.vercel.app//api?username=mindlabordev&rank_icon=percentile)](https://github.com/anuraghazra/github-readme-stats)

Yes, this seems better UX-wise. UI-wise you could make "Top" the same size as other text like "total stars earned" but that's just me being picky. 👍

[rickstaa]

I personally think the top percentage (for example top 0.9% instead of 99.1%) is better as it carries more meaning. You cant compare yourself against numbers without units/meaning or with too complicated units/meaning. A top percentage is an easy and intuitive metric.

Does #2859 suit your need?

[![Anurag's GitHub stats](https://github-readme-stats-git-addpercentilerankicon-rickstaa.vercel.app//api?username=mindlabordev&rank_icon=percentile)](https://github.com/anuraghazra/github-readme-stats)

Yes, this seems better UX-wise. UI-wise you could make "Top" the same size as other text like "total stars earned" but that's just me being picky. +1

Nice tip. I updated the styling. If you have any other improvements, let me know.

[![Anurag's GitHub stats](https://github-readme-stats-git-addpercentilerankicon-rickstaa.vercel.app/api?username=mindlabordev&rank_icon=percentile)](https://github.com/anuraghazra/github-readme-stats)

[rickstaa]

Hard to see the difference but top is also 14px now (see 3de7ab4). I left the percentage at 16px which is equal to the progress icon size.

[web-dev-sam]

yea hard to tell but this is absolutely fine.

[rickstaa]

yea hard to tell but this is absolutely fine.

Cool thanks for the amazing feedback. I will ask @qwerty541 to review and merge your feature request.

[rickstaa]

@silverwind do you prefer the progress over the percentile rank icon proposed by @MindLaborDev? If you also think the percentile version is more clear, we can maybe revert the progress pull request 🤔,

[rickstaa]

@silverwind, we decided to replace progress with percentile since it is unclear to users what progress means (see #2859 (review)). Therefore, it would be best if you changed progress to percentile in your README.