A++ rank in readme?
Describe the bug
Not certain if displaying A++ on the example in repo should be showing a rank that is not part of the ranking system.
Currently pulled in from this image:
@anuraghazra if you have the capability to regenerate with S rank ( or possibly regenerate with couple different examples) this could improve understanding.
Expected behavior
No response
Screenshots / Live demo link
No response
Additional context
No response
just to check if I'm understanding this correctly, the "A++" is meant to be a "S"?
The readme (above the image) has a section stating:
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, reviews, 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.
And the codebase for the calculator has S not A++. ref: anuraghazra/github-readme-stats_calculateRank
I feel the bug you are point out is not related to the code
code where the ranking is defined doesn't include A++
ref: anuraghazra/github-readme-stats_calculateRank line 69 - const LEVELS = ["S", "A+", "A", "A-", "B+", "B", "B-", "C+", "C"];
ref image -
there is no mention of A++ in the whole codebase
the issue and the image you are referring doesn't exist with the same account
https://github.com/anuraghazra
the image @maxo99 might have mentioned might not be generated by the code in reference instead some other repo code might be used
" this issue might not be related to this codebase "
Hi @Aryan27-max ,
The image I provided was from https://github.com/anuraghazra/github-readme-stats?tab=readme-ov-file#all-inbuilt-themes which is just displaying the available themes.
So it's just a inconsistency between what is shown in the documentation and what can actually be generated. Since there is no A++ in the actual grading scale.
This is not at all urgent.
Documentation is critical for adoption and usability! I'd love to help improve this. 📚
📖 Documentation Enhancement Strategy
What Makes Great Documentation:
- Clear Getting Started: Step-by-step onboarding for new users
- Comprehensive Examples: Real-world usage patterns and code samples
- API Reference: Complete parameter docs with types and examples
- Architecture Overview: High-level system design and data flow
- Troubleshooting Guide: Common issues and solutions
- Best Practices: Recommended patterns and anti-patterns
Content Areas I Can Contribute:
- ✍️ Written Content: Clear, concise explanations
- 💻 Code Examples: Working, tested examples
- 🎨 Diagrams: Architecture diagrams, flowcharts, sequence diagrams
- 🎥 Tutorials: Step-by-step guides with screenshots
- 🔧 Interactive Demos: CodeSandbox/StackBlitz examples
- 📋 Cheat Sheets: Quick reference guides
My Approach:
- User-centric: Written for different skill levels
- Example-driven: Show don't just tell
- Maintainable: Easy to keep up-to-date
- Accessible: Clear language, good structure
Specific Contributions: I maintain documentation for several popular projects and can provide:
- Technical writing expertise
- Working code samples
- Diagram creation (Mermaid, Draw.io, etc.)
- Documentation review and editing
What documentation areas need the most attention? I'm ready to contribute! 📝