Home› Module 18› GitHub Profile Guide
Module 18 · Guide 4

GitHub Profile Guide

Turn your GitHub profile into a professional showcase that works even when you are not applying.

Why GitHub Matters

GitHub is the developer's LinkedIn. Recruiters and hiring managers look at GitHub profiles to verify skills and see real code. An active GitHub profile with clean, well-documented projects tells a story that a CV cannot.

The good news: you have already been using GitHub throughout this roadmap. Now let's make sure your profile presents that work in the best light.

Profile Basics

Choose a professional username

Your GitHub username appears in every repo URL and contribution. Avoid usernames with numbers, random characters, or juvenile references. Use your real name or a professional variant: john-smith, jsmith-dev.

Profile photo

Use a real, professional-looking photo of your face. Avatars and logos are fine for personal accounts but make you look less serious to recruiters.

Bio

Keep it short (1–2 lines). Include: what you do, what you are looking for, and optionally your location. Example: "Frontend Developer | HTML · CSS · JavaScript · React | Open to Junior Roles"

Fill in your website link

Link your portfolio site. This is prime real estate — do not leave it blank.

The GitHub Profile README

GitHub shows a special README if you create a repository with the same name as your username (username/username). This README appears at the top of your profile page.

Good profile README elements

  • A brief professional introduction
  • Technologies you work with (icon badges look great)
  • Current focus ("Currently learning React")
  • Links to your portfolio and LinkedIn
  • GitHub stats card (optional — use sparingly)

What to avoid

  • Overly long READMEs with walls of text
  • Skills bars showing percentages
  • Excessive badges and widgets that slow the page
  • Anything that looks like it came from a generator template you didn't customise

Pinned Repositories

You can pin up to 6 repositories to appear prominently on your profile. Pin your 3–6 best projects — the ones with the best code, most complete README, and working live demos.

For each pinned repo, GitHub shows the name, description, primary language, stars, and forks. Make sure:

  • Every pinned repo has a clear, one-sentence description
  • The repo name is clear and professional (not "test", "stuff", "project1")
  • The primary language detected is correct (it uses file statistics)

Writing Good READMEs

A good README is the front door to your project. Recruiters and potential collaborators decide within seconds whether your project is worth exploring. Include:

README template

# Project Name

A brief one-sentence description.

## Live Demo
[View live project](https://username.github.io/repo-name)

## Screenshot
![Screenshot of the app](./screenshot.png)

## Features
- Feature 1
- Feature 2
- Feature 3

## Technologies Used
- HTML5
- CSS3 (Flexbox, Grid, Custom Properties)
- Vanilla JavaScript (ES6+)
- Open-Meteo API

## What I Learned
Brief paragraph about the interesting challenges and what you learned
building this project.

## Getting Started
Open `index.html` in a browser — no build step required.
A README with a screenshot gets significantly more engagement than one without. Take a screenshot of your project and add it to the repository.

The Green Squares (Contribution Graph)

The contribution heatmap on your profile shows how actively you commit code. Consistent activity over months looks much better than a burst of 200 commits in one week followed by silence.

How to build a consistent contribution graph

  • Commit something every day you work on code — even small improvements count
  • Use real commit messages, not "wip" and "fix"
  • Make sure your commits are made with the email you registered on GitHub (git config user.email)
  • Work on public repositories — commits to private repos show as solid squares without detail
Do not try to game the contribution graph with fake commits or commit date manipulation. Experienced developers can spot this immediately and it is a red flag.

GitHub Profile Checklist

  • Professional username, photo, and bio
  • Portfolio website linked
  • Profile README created and customised
  • 3–6 best projects pinned
  • Each pinned project has a clear description
  • Each project has a README with description, screenshot, and live demo link
  • Contribution graph shows consistent recent activity
  • No repositories named "test", "asdf", or other placeholders
← Portfolio Guide Resume Guide →