Show Your Projects on GitHub: README, Profile and Portfolio

Your GitHub is a portfolio

Recruiters and hiring managers for data, software and web roles open your GitHub profile. In a few seconds they decide: does this person build real things, and can they explain them? You cannot control the first look, but you can design it.

A strong profile has: a clear bio, a handful of pinned projects that are worth showing, a README on each that explains the work, and a history of steady commits. This lesson shows you how.

Work from your computer: three ways

Browser uploads are fine for tiny things. For real projects you will use one of these, and they all do the same thing underneath:

Whichever you choose, the habits are the same: small commits, clear messages, and a push when you finish. Use Fetch and Pull to bring in changes made elsewhere.

Write a README that sells the project

The README is the first thing people read. It should let a visitor understand the project in thirty seconds. This structure works for most student and junior projects:

# Sales Analysis: Kolanut Drinks

Analysis of 4,000 orders to find which regions and products drive revenue.

## What I did
- Cleaned the data in Python (pandas)
- Calculated revenue by region, category and month
- Built charts to show the trends

## Key findings
- Lagos brings in about half of all revenue
- Household products are the top category

## Tools
Python, pandas, Google Colab

## See it
Open `analysis.ipynb` or view the charts in `/images`.

Tips that separate a good README from a forgettable one:

• Lead with the point. One sentence on what it is and why it matters.
• Show results with numbers ("revenue fell 47%"), not only activity ("I did analysis").
• Add a picture. A screenshot or chart makes a README far more engaging. Save it in an images folder in the repository, and show it with Markdown's image line, which starts with an exclamation mark, then the description in square brackets, then the file path in round brackets.
• Say how to run or view it, so a visitor can try it.
• Be honest about what you built yourself and what you followed from a tutorial.

Make your profile a portfolio

• Pin your best repositories. On your profile, click Customize your pins and choose up to six. Put the strongest first.
• Profile README. Create a public repository named exactly your username, with a README.md. Its content appears at the top of your profile. Say who you are, what you are learning, your best projects and how to reach you.
• Describe every repository. Add a one-line description and topics (tags such as python, data-analysis) in the repository's About box.
• Keep it tidy. Make unfinished experiments private, or archive them. Give every public repository a README.
• Add a licence to projects you want others to reuse (MIT is a common choice).

A profile README can be as simple as:

# Hi, I'm Ada 👋
Economics student at UNN, learning Python, SQL and data analysis.

## Projects
- [Sales analysis](https://github.com/ada/sales-analysis): which regions drive revenue
- [Recipe site](https://github.com/ada/recipe-site): a small website, built with HTML and CSS

## Reach me
LinkedIn: linkedin.com/in/ada-okafor

Commit history and the green squares

Your profile shows a grid of green squares for your commits. Do not obsess over it, and never fake it: recruiters read the commits, and a wall of empty "update" commits looks worse than a quiet graph. Steady, real work, with clear messages, speaks for itself.

Share it

• Put your profile link on your CV and LinkedIn. Link to the specific repository next to each project you describe.
• In a job application, point to the one or two projects most relevant to the role.
• Make sure the pinned projects work: click your own links from a private window to see what a visitor sees.

Try it

Write the README for a real project of yours.

Now publish it, and make your profile work as a portfolio.

Finally, add your GitHub profile link to your CV and your LinkedIn profile.