The Github Contribution Stats
Tags: github, webdev, javascript, git
Published: 2020-07-20 06:05:54

---
title: The Github Contribution Stats
published: true
description: 
tags: github, webdev, javascript, git
cover_image: https://dev-to-uploads.s3.amazonaws.com/i/0j87sxmyhpakgimqpidl.gif
---

# Hello, World!

I just want to share this project about how you can dynamically generate a template of your Github contribution stats based on the Commits, Pull Requests, Issues and Code Reviews.

- Sample generated template (some of our famous open source contributor :trophy:):
 
  - [Miško Hevery](https://github.com/mhevery)

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

  - [Taylor Otwell](https://github.com/taylorotwell)

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

  - [Fabien Potencier](https://github.com/fabpot)

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

The ratings scale are based on this [Academic Grading In Japan](https://en.wikipedia.org/wiki/Academic_grading_in_Japan) I was fascinated with that ("S" rarely given :joy:) 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](https://github.com/LordDashMe/github-contribution-stats/blob/master/src/ContributionRatings.js)

## Usage

Just copy paste this into your markdown content and replace the value of the **?username=** URL parameter based on your Github Username.

```text
[![Contribution Stats](https://github-contribution-stats.vercel.app/api/?username=lorddashme)](https://github.com/LordDashMe/github-contribution-stats/)
```
Probably you will 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 give a **star** in the project and after a couple of minutes this will disappear, we need this minutes because we implemented a caching for each generated template.

## Purpose

Actually if you don't know Github released a feature Github README profile (they say a Secret Repository :smile:). You can check this article on how it works [How to add GitHub Profile README (new feature)](https://dev.to/tumee/how-to-add-github-profile-readme-new-feature-1gji ). And I think this project will give you additional content to include or show for your Github README Profile.

## Contribute

Yes! the project is open for any idea or suggestion just visit the repository [Github Contribution Stats](https://github.com/LordDashMe/github-contribution-stats/) and don't forget to **star** the repository :blush: that will help a lot!

## Edited July 21, 2020

Appreciated all the comments and suggestions :heart:. I never thought that this post will be active like this and all of you supported this. 

There's still so much room for improvement since then many changes applied to enhance it further! thank you so much for the support! :tada:

- Special mention to:
  - [Benjamin Trent](https://dev.to/benwtrent)
  - [Marcell Cruz](https://dev.to/____marcell)