DEV Community

Cover image for Tips to use GitHub as your Portfolio
Pachi 🥑
Pachi 🥑

Posted on

Tips to use GitHub as your Portfolio

Hello everyone!

Today I came to talk to you about a topic I love to talk about because it applies to people of all skill levels and any area within technology: How to use GitHub as a Portfolio!

Although it's not mandatory, it's common for recruiters to want to see your GitHub and sometimes also ask for a Portfolio, so why not combine the two?

GitHub is the ideal place because there you can showcase examples of your code, your progress, your studies, and initiatives you've been involved in. In today's article, I'll share some tips on how to do that.

1. Your README

Let's start with the most important part, your homepage on GitHub: The README.

Here, you can use text, graphics, and GIFs to convey your message. Check out mine:

example of readme

How to do it?

Firstly, you have to create this file.

  • Go to New Repository.
  • The name of this new repository has to be your GitHub @.
  • If you type it correctly, you'll see this message:

secret message

  • Check the box for Add a README file if it's not already checked.
  • Create the Repository.

Now you have access to this 🌟special🌟 repository.

What do I put here?

You can put several things. In mine, I have my Bio, my Skills, Social media, and a list of my 5 most recent articles.

My recommendation is to have at least the bio. Mine is in English, but write in the language most relevant to you!

If you're feeling uninspired, I recommend using this site https://www.profileme.dev/. Here's a template to fill out, and in the end, you'll have access to the .md file, so just copy and paste it into your README.

If you're familiar with markdown and are a creative person, you can make this look really nice, like GitHub Star Levxyca's profile, which is simple but lovely:

profile example

2. Fill in the Left Column

When you visit a profile on GitHub, even if the person hasn't created the README we talked about above, they have a column on the left with basic information, and it's important that you have this section filled.

I'll use another GitHub Star, Julio Arruda, as an example:

Julio Arruda's page

His profile is complete, and you can follow this example by filling in:

  • Your name
  • The @ is automatic, but now you can add your personal pronouns here!
  • A short bio: Quick stuff, your title, or aspiration. Mine is the same as the Twitter Bio.
  • Where you work (or study)
  • Country of residence and you can also display your time zone
  • Below, you can include all the links you find relevant.
  • If you're seeking employment or open to partnerships, I recommend leaving your email here too.
  • If the email option doesn't appear here, you'll have to go to Settings > Emails and uncheck the option Keep my email addresses private.
  • Now you can go back to your profile, and the option to add your email will appear.

Cool, now you have a fully completed profile column and a neat README! That's the basics, but we can do a little more.

3. "Pinned" Projects

Right below your README, you have the option to "pin" projects, which means highlighting them.

You can choose from 1 to 6 of your projects. Pick the projects you're most proud of! Here, you can see the choices of GitHub Star Erika Heidi:

Erika's projects

A tip I give for all repositories, but especially important for those you want to highlight, is to write a short description of the project. Just what the project does and the technology used.

In the example image above, for the MiniCli project, the description is: A minimalist framework for command-line applications in PHP.

This is important because this information is visible without the person having to click on the repository to know more. So, when they open the repo, it's because it interests them. This makes it easier for recruiters to look at your profile.

How's your profile?

Well, folks, those are my main tips to make your profile not only attractive but also functional. These tips might seem simple, but in the current competitive market, small things can make a difference in the selection process.
Let me know what you have done on your profile!

Top comments (10)

Collapse
 
zaidkamil profile image
zaid bin kamil • Edited

tell me how my profile looks @ github.com/zaid-kamil. I used this generator to create my profile. gprm.itsvg.in/

Collapse
 
ebenjs profile image
Ebenezer Nikabou

Hey @zaidkamil the link you provided was really helpful. Thanks.

Collapse
 
kaamkiya profile image
Kaamkiya

Thanks for this! It made me rethink my README. I didn't use the generator you suggested, I found a different one, but it was very useful. Thanks!

Collapse
 
markmaksi profile image
Mark Maksi

Great article. One tip I got from a senior engineer at Google is not just add pinned posts, but include the repos that you want employers to see in the README file with links and live demo or a video showing how it works. The reason is that the repositories tab lists repos based on the last activity, and you might not want employers to see the latest repo you committed too. So enhance the employer experience on your GitHub.

Collapse
 
pachicodes profile image
Pachi 🥑

That is a great tip!

Collapse
 
valeriahhdez profile image
Valeria writes docs

Great tips, thank you for the ideas 🙌

Collapse
 
ther4v3n profile image
R4V3N

Nice article with good tips. Here is my profile. github.com/The-R4V3N

Collapse
 
tharunbalaji31 profile image
Tharun Balaji R

Nice article, checkout my github profile - github.com/TharunBalaji2004

Collapse
 
shahriarshafin profile image
Shahriar Shafin
Collapse
 
artoodeeto profile image
aRtoo

Thank you for this. When they did this? been on gitlab so much for work. thank you!