Have something to show
GitHub Profile README: 3 Templates + Guide
Priya liked Aarav's resume. She clicked his GitHub link. She saw: a default grey avatar, no bio, twelve repos named test , hello-world and project-final-2 , and a contribution graph that was grey for nine months. She closed the tab. Ten seconds.
5 min readFree, no email neededUpdated 11 September 2026
Ten seconds on your profile
Priya liked Aarav's resume. She clicked his GitHub link. She saw: a default grey avatar, no bio, twelve repos named test, hello-world and project-final-2, and a contribution graph that was grey for nine months. She closed the tab. Ten seconds.
Your GitHub profile is the one place a recruiter can check whether your resume is true. She is not reading code. She is looking for four things, top to bottom:
The README is the only one of the four you can fix in five minutes. This guide is that five minutes.
First, the secret repo that makes the README appear.
The secret repo
GitHub has a trick: make a repository with exactly the same name as your username, and the README.md inside it is shown at the top of your profile page. Nothing else does this.
Open github.com/new. In "Repository name", type your username exactly. If your profile is github.com/aarav-sharma, the repo name is aarav-sharma.
GitHub shows a green box: "You found a secret! aarav-sharma/aarav-sharma is a special repository." If you do not see it, the name is wrong. Check capitals and hyphens.
Keep it Public. Tick Add a README file. Click Create repository.
Open README.md, click the pencil icon. Delete the default line. Paste the template you chose from the ZIP.
Replace Aarav's details with yours (name, college, links, email). Click Commit changes.
Open github.com/your-username. The README is at the top. Edit it any time the same way.
What goes in each section
All three templates use the same five sections. Here is what each one is for, and the rule for writing it.
- 1Intro lineName, year, degree, college, what you build, what you want. One sentence. "Final-year B.Tech CSE at PICT. I build full-stack apps with React and Node. Looking for a developer role from July 2027." No "passionate", no "enthusiast".
- 2What I'm learningTwo items, both true this month. It tells her you are still moving. "TypeScript and Next.js" is good. "Machine learning, blockchain, cloud, DevOps" is a red flag.
- 3Projects tableTwo or three rows: name, what it does in one line with a number, stack, links. The links are the whole point. "Live" must open on a phone. Same projects as the resume, same names.
- 4Tech stack badgesSix to ten badges you can answer questions about. Group them: Languages, then Frameworks and tools. Every badge is a promise that you can be interviewed on it.
- 5Reach meLinkedIn, email, resume PDF link. One line. No phone number on a public page. Use the same email as your resume.
The one rule: everything on the README must match the resume. Different project names, a skill listed here but not there, a college year that differs. Priya notices, and it costs you trust.
Which one, and the snippets
README-minimal.mdMinimalFirst or second year, or 0–1 finished projects. Short and honest beats long and padded.README-projects.mdProjectsTwo or more projects with live links. Use this one in placement season. It is what Priya wants.README-stats.mdStatsOnly if your graph is green most weeks. A stats card with "12 commits this year" hurts you.Badges: one URL pattern
Stats cards
Then pin the repos. On your profile, click Customize your pins and tick up to six, best project first. Each pinned repo needs a one-line description (the gear next to About) and its own README with a screenshot and a live link. The profile README sends her there; the pinned repo has to hold her.
Four mistakes
Thirty badges, four rows, including Kubernetes and Rust. Priya's first question will be about the one you know least. Keep six to ten, all defendable.
A projects section with names and no Live or Code link is a list of claims. Every project row needs at least one link that opens. A dead link is worse than no link.
"test", "hello-world", "project-final-2", forks you never touched. Delete or make them private. Pin the four best. Give each pinned repo a one-line description and a README.
A README above a grey avatar and an empty bio looks copied. Add a photo, a one-line bio, your college and city, and the same links. Two minutes, in Settings, Profile.
Want this on your phone?
Everything above, as a PDF built to read on a phone the morning of the interview. It costs nothing — we ask for an email so we can send it, and that is all.