Get your dynamically generated Github Contribution Stats! 📈 📆
-
See an example of usage with some of our well-known open source contributors. 🏆
Simply copy and paste this into your markdown content, replacing the value of the URL parameter ?username= with your Github username.
[](https://github.com/LordDashMe/github-contribution-stats/)
Actually, if you don't know, Github released a feature called Github README profile (they call it a Secret Repository 😄) and I think this project will help you to give additional content for your Github README profile.
The table for the Rating Range, Letter Sign and Color.
| Rating Range | Letter Sign | Translation | Color |
|---|---|---|---|
| 100 - 98 | S | Excellent | #eacb2f |
| 97 - 81 | A+ | Very Good | #1eb300 |
| 80 - 41 | A | Very Good | #2fa0ed |
| 40 - 31 | B+ | Good | #ed962f |
| 30 - 21 | B | Good | #7d00b3 |
| 20 - 0 | C | Average | #b30000 |
The rating scale is based on the academic grading system used in Japan. I was fascinated with that ("S" is rarely given 😂). We also used some of the common formulas in statistics like (Mean, SD, Z-Score, etc.) to get the final scores based on the 4 data sets (Commits, Pull Requests, Issues, and Code Reviews). If you want to check the technical details of the ratings, here is the file ContributionRatings.js.
These features will be added soon. We will unlock the layout customization depending on what you like ❤️.
You probably notice that the generated template has a comment or message below the stats. We added this feature in order to preserve the origin of the project. If you want to remove this, just make sure you star the project (this repo) and after a couple of minutes this will disappear. We need these minutes because we implemented caching for each generated template, so the delay is expected but not so much 😊. If ever you encounter an issue, we'll be glad if you tell us here in Github Contribution Stats Issues.
This project only needs a star ⭐ from you! ❤️ If you ever enjoyed this project, share it with your friends who are also active on github 🤝.
For those who are currently using it right now with their Github README profile:
-
And you! If you are using it right now and you are not on the list, please tell us by sending an issue Github Contribution Stats Issues. We are delighted to include you on the list as well.
This package is open-sourced software licensed under the MIT license.