Skip to content

chunkeat99/github-contribution-stats

 
 

Repository files navigation

Github Contribution Stats

Get your dynamically generated Github Contribution Stats! 📈 📆

A treasure! ✨

Demo

Usage

To use, just copy paste this into your markdown content and replace the value of the ?username= URL parameter based on your Github username.

[![Contribution Stats](https://github-contribution-stats.vercel.app/api/?username=lorddashme)](https://github.com/LordDashMe/github-contribution-stats/)

Purpose

Actually if you don't know Github released a feature Github README profile (they say a Secret Repository 😄) and I think this project will help you to give an additional content for your Github README profile.

Ratings

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 ratings scale are based on this Academic Grading In Japan I was fascinated with that ("S" rarely given 😂) and also we used some of the common formula in Statistic 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 check the technical details of it you can visit this file ContributionRatings.js.

Layout Customization

This features will be add soon. We will unlock the layout customization depending on what you like ❤️.

Support

Probably you notice that the generated template has a 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 and after a couple of minutes this will be disappear, we need this minutes because we implemented a 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 file it here Github Contribution Stats Issues.

This project only need a star ⭐ from you! ❤️ if you ever enjoyed this project, share it to your friends who are also active in github 🤝.

License

This package is open-sourced software licensed under the MIT license.

About

Dynamically generated Github Contribution Stats. 📈 📆

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%