GitHub Profile and Portfolio Guide: Make Your Code Easy to Hire

What recruiters do with your GitHub

Many technical recruiters and interviewers open your GitHub link after the resume. They spend a minute or two, so your profile must answer quickly: What do you build? Can you write clean code? Do you finish projects? You do not need thousands of commits. You need a few clear, working, well-explained projects.

1. Set up the basics

• Use a professional username (your name or a clean variation)
• Add a photo, a short bio, location and a link to your LinkedIn or portfolio site
• Use an email you check regularly
• Connect your commits to your account: configure Git with the same email you registered on GitHub (Git guide)

2. The profile README

Create a repository with the same name as your username; its README appears at the top of your profile. Keep it short:

# Hi, I'm Asha 👋
Final-year CSE student building web apps with React, Node.js and PostgreSQL.

## What I'm working on
- Job tracker app (live demo below)
- Learning system design and data structures

## Skills
JavaScript · TypeScript · Java · SQL · Git · Docker (basic)

## Projects
- [Job Tracker](link): track applications with reminders
- [Expense Splitter](link): groups, balances and settlements

## Contact
asha@example.com · LinkedIn link

Avoid walls of badges, animated widgets or stats that distract from the content.

3. Pin your best 4–6 repositories

Choose projects that show range and depth: for example a full-stack app, an API with tests, a data project and something that solves a real problem. Unpin tutorial copies, empty repositories and anything unfinished. Give every pinned repo a clear one-line description and relevant topics (tags).

4. Write a great project README

The README is more important than the code for first impressions. Include:

• What it does and why (two lines)
• A screenshot or short demo video / live link
• Tech stack
• Features
• How to run it locally, step by step (and check that the steps really work)
• Folder structure or architecture in a few lines
• Challenges and what you learned, and future improvements

See the template in portfolio projects that get interviews.

5. Keep your code clean

• Meaningful names for files, functions and variables
• No secrets in the repo: API keys, passwords and .env files must never be committed (Git guide)
• A proper .gitignore
• Small, descriptive commits such as "Add pagination to job list", not "update" or "final final"
• Tests for the important logic, even a few
• A license file if you want others to reuse your code
• Remove dead code and commented-out experiments

6. Show consistent activity (without gaming it)

Regular commits are a good sign, but quality matters more than the green squares. Avoid fake commits or auto-generated activity; experienced reviewers can tell. A realistic pattern is steady work on a couple of projects over months.

7. Contribute to open source (optional but impressive)

Start small:

• Fix typos or improve documentation in a project you use
• Look for issues labelled good first issue or help wanted
• Read the contributing guide, make a small pull request and respond politely to feedback

Even one merged pull request in a known project is a strong signal.

8. A simple portfolio website

A single page can help non-technical recruiters:

• Your name, role and a short introduction
• Three projects with images and links
• A downloadable resume
• Contact links

Host it free on GitHub Pages, Netlify or Vercel. Keep it fast, responsive and easy to read; it should not be a design experiment.

Role-specific tips

• Data roles: include notebooks with clear explanations and a README that states the question, data source and findings
• DevOps: include infrastructure code, pipelines and diagrams
• Frontend: live demos matter most
• Mobile: screenshots, a demo video and a Play Store link if published

Mistakes to avoid

• A profile full of forked repositories and no original work
• READMEs that only say "my project"
• Hard-coded secrets and personal data
• Linking a GitHub profile that has nothing useful on it; fix it first

Next steps

Add your profile link to your resume and LinkedIn, then apply for internships and fresher jobs.