How to build stunning GitHub Profile and Attract Recruiters

ABHISHEK GUPTA
6 min readFeb 10, 2021

If you are a developer or a Data Scientist or someone who uses GitHub for different projects, here is something very interesting for you. As we all know, first impression counts, so why not build an attractive GitHub profile that summarises your technical experience and expertise.

What makes this article special is, not just it guides you creating the GitHub profile but also it includes the four very special lessons that I learnt while working on it. I have shared my learning experience after the main content below with the hope that as a Data Scientist or Developer, those techniques would be valuable to you and add value to your professional experience.

What you will learn beside building Github profile (lessons):

1. Uploading Images to Github

2. Creating Metadata Badges

3. View the complete Script with Github Gist

4. How to add Medium Articles in README.md

Through this article, I will guide you to make your personal README.md file look perfect and quite like your resume. This will also help you stand out to the recruiters and even grab people’s attention to your work.

You might be wondering, HOW?

The Answer is: by creating a special 🦄 Github repository for your Github profile.

Here is how my Github Overview currently looks like (isn’t it better that the normal one 😉).

You can also make similar to this for your Github overview page by following the below-mentioned steps:

1. Create a Repository with the same name as your username:

Creating a repository with the same name as your username enables a special GitHub repository for you to add a README.md file of your GitHub profile that you want to create. Follow the arrows in the picture below that wolud help you to create the repository:

2. Write the Script on README.md

Once the repository is created, select the README.md file and click on edit sign on top right corner.

Next, you need to decide what would be the contents of your profile or how exactly you want it to look like. You can have a look how my GitHub profile is currently looking like: https://github.com/sargupta

Complete Script:

Use the following script to create your own attractive GitHub profile. What you need to do is, just customise username, files and all other necessary portions that needs some modification to make it your own. I would highly encourage you to pay attention and work section by section so that you can understand and implement the script with ease (and learn with comfort). The script is commented

Side not: You can also use Markdown to add headers, links, images, and even emojis 😉. It’s absolutely acceptable.

If you find any difficulties to implement, feel free to comment below or contact me through details provided in my profile above.

The main content ends here. But if you want to know what were my most valuable lessons while working on it, follow the next section where I will be sharing three useful lessons that would add additional techniques to your arsenal.

4 Important Lessons that I Learned:

What is most important for me while working on a project is the techniques/lessons I learned while working on it. Therefore, I am sharing with you my top 4 lessons (4th is the most interesting one to me).

1. Uploading Images to Github

Storing your images/files in GitHub couldn’t have been smoother.

2. Creating Metadata Badges

Metadata Badges

You can create the metadata badges using Shields.io which is a service for concise, consistent, and legible badges in SVG and raster format, which can easily be included in GitHub readmes or any other web page. This really makes the README file stand unique.

Here you can find how to create those badges:

3. View the complete Script with Github Gist

To make your Medium post look more appealing and readable, I would recommend using Github gist for adding script or even lines of code whenever you need to add some script on Medium story.

Here is how you can do that:

3.1 Generating Github Gist

Open your GitHub page and click on ´+´ sign on top-right corner, then select New gist

(Optional) Just for your knowledge, there is another way of landing into step 3.2

3.1.1 (Alternative of 3.1) Go to GitHub Gist page

Go to your profile icon and click on Your Gists

3.1.2 (Alternative of 3.1) Generate Github Gist page

Click on the ´+´ on top-right corner of the GitHub Gist page.

3.2 Fill the details as mentioned in the blow image.

Since we are publishing it on Medium, we need to make it Public and how do we do that? Simple! Click on the bottom right arrow (shown below) and select Create public gist

Now, paste the newly created GitHub Gist link at the desired space and press enter.

A shorter sample of it look like this (part of Point-4):

4. How to add Medium Articles in README.md

In order to add your Medium article in GitHub README, you just to add this script in your README.md file.

It would look something like the following:

### Latest Medium Articles

<a target="_blank" href="https://github-readme-medium-recent-article.vercel.app/medium/@sargupta93/0"><img src="https://github-readme-medium-recent-article.vercel.app/medium/@sargupta93/0" alt="Recent Article 0"></a>
<a target="_blank" href="https://github-readme-medium-recent-article.vercel.app/medium/@sargupta93/1"><img src="https://github-readme-medium-recent-article.vercel.app/medium/@sargupta93/1" alt="Recent Article 1"></a>

Where, you need to make changes on below mentioned points:

  • Medium-username: your medium username/profile
  • Article-index : your recent article index. e.g: `0` means your latest article.

Final Words:

I hope you liked and enjoyed it! Having said that, I encourage you to take some time and give it a try, no matter what level of experience you have, it will definitely make your GitHub profile look better and create a positive impression to the recruiters.

Acknowledgment:

I must thank my dear friend taamfp for sharing his Github overview page with me which grabbed my attention at the very first sight and inspired by his effort, I too decided to make my Github Profile look Cool! And here I am sharing my experience with you all, Enjoy!

References:

  1. Readme Stats (also useful for playing with the themes):

2. How to add Medium Link

--

--