Skip to content

Latest commit

 

History

History
85 lines (46 loc) · 5.08 KB

Displaying Contributors Image on README files with no Pain!.md

File metadata and controls

85 lines (46 loc) · 5.08 KB

Displaying Contributors Image on README files with no Pain!

Use contributor-img to generate an image that displays contributors on your GitHub repository.

January 10, 2021 - 3 min read

space-1.jpg
Photo by Icons8 Team on Unsplash

Introduction

In this beautiful world, contributors play a prominent role in contributing their wealth, knowledge, happiness to the community, projects, society, or even a solution to a never-ending problem. Whenever I hear the word contributors, one place that always comes to my mind is GitHub. Well, nothing crazy GitHub has over 56+ million users aka developers, 3+ million organizations, and over 100+ million repositories. Out of which there are over a million active contributors who push several hundred or thousands of lines of code to other repositories. This happens on a daily if not hourly basis.

Now, if you have a GitHub repository that has over a thousand forks or stars. You might/will get a lot of pull requests as I do. This is a common fact. Each time you merge a pull request into your repository, the one that generated the initial request will automatically become the contributor to your repository. Well, I’ll tell you what folks, there is no other simple way to stop this. Just admit it.


Navigating to the contributor dashboard

There is a way to navigate to the contributor's dashboard from your repository itself. All you have to do is navigate to Insights → Contributors. Here you can view the additions, deletions, and commits performed by your contributors on your repository. A screenshot of my not so famous repository is given down below.

space-1.jpg
There are 10 contributors bringing them all together was very throbbing. GitHub

Contributors displayed by GitHub (not on the Readme.md file)

GitHub sorta does a good job in displaying the contributors at the bottom right-hand corner of your repository as shown below.

space-1.jpg
Contributors displayed by GitHub

But what if you need to need to display the contributors in your Readme.md file? Don’t even think of just bluntly writing all the contributors using Markdown. It’s 2021 there are amazing web applications that can generate the list of contributors as images. One such example is contributors-img.


Contributors displayed by using contributors-img (on the Readme.md file)

contributors-img — A web application that generates an image to display contributors of your GitHub repository. — Suguru Inatomi

Generating the image is very trivial. All you have to do is navigate to contributors-img and then paste the name of your repository along with your username to generate the URL as shown below.

space-1.jpg
Using contributors-img to generate an image

Or you can also use the code to generate an image. Copy-paste it in your Readme.md file.

<!-- Copy-paste in your Readme.md file -->

<a href = "https://github.com/Tanu-N-Prabhu/Python/graphs/contributors">
  <img src = "https://contrib.rocks/image?repo = GitHub_username/repository_name"/>
</a>

Made with [contributors-img](https://contrib.rocks).

Well, there you go. After entering your credentials such as GitHub username and repository name you should be able to see an image that has all your contributors. In my case, it will exactly as shown below.

space-1.jpg
Displaying Contributors Image on Readme.md file

Conclusion

Well, there you go guys you have now successfully learned how to generate contributors’ images and display them on your Readme.md files using the contributors-img web application. So have you used it before reading this article? If yes, tell me something more about it in the comment section. If not, tell me after you use it. Anyway, before ending this short tutorial always keep in mind to give credits to the contributors, this is often a good practice. This is followed very often in the tech industry. Alright, time to say goodbye. Stay tuned. More fun tutorials are yet to come. Until then have a good day/night. Stay safe!!!

Written By Tanu Nanda Prabhu using Markdown
Version 1.1 - Last Updated on 11-1-2021 on 10:33 PM