Github is awesome, that's known.
But, did you ever think how to make yours more attractive for potential employers or other visitors? Even non-tech ones like recruiters!
So take a couple of hours and show your best side as a person - and a programmer.
This article is based on a talk I gave in our fullstack course.
Your profile image
Not everyone likes to put a photo of themselves. However, if you are looking for a job- get over yourself and do it.
The best advice I can give to you, apart from getting a professional photo, is to ask a close person to take your photo.
- Find a well-lit room with an uncluttered background. Outdoors is also great, but avoid being in direct sunlight.
- Have fun with it! Laugh about how embarrassing it is, make faces, whatever gets you to look more like you and less staged - will do the trick.
- Ask them to take many photos in some variations- close or far, smiling/serious etc.
- Later, choose the ones you both think are the most flattering. Ask honest people that you know to choose The One.
Yes, it's embarrassing and awkward, I know. But hey, after you start your new job you can always delete it.. :)
Profile Readme
Github has a special readme feature - use it.
It is your place to say hello and present yourself.
You can make do with a short paragraph about yourself, or completely kill it- but have one.
It's almost rude not to 😉
Pinned Repos
You can pin upto 6 repos. Use them wisely.
Remember that github is like inviting strangers to your study- It's ok to have lots of stuff lying around, but make it easier for them to know what is the work you consider your finest.
Contributions and the Big Green
Github automatically generates a visual representation of your contributions. It's shallow and does not distinguish between removing a comment and reinventing google, yes. But it's easily readable by tech and non-tech people alike.
I'm not saying you should make commits just to make the green greener, but.. I'm a bit saying that, yeah.
Commit messages
Commit messages are a window into your soul. They help you -and others- see your thought and work process.
Short and descriptive comments are best, and give a sense that you are able to focus on tasks and easily explain what have you been working on.
I use the built-in diff tree in VSCode before every push to make sure I can describe what is the major change in the commit.
But read wiser people than me about it.
Project Readme: Window Dress your Code
Whether it's a weekend project or something it took you weeks to built, increase the odds that others will appreciate it by adding a descriptive readme file.
Use the readme markdown to have nice titles, bullets etc.
In the projects I choose to showcase, I try to at least have 4-5 out of these:
- A simple description of the project- what is it about? Why did you do it?
- 1-3 screenshots
- Link to live version if you deployed it to netlify/ heroku
- Tech specs- stack, components scheme, libraries etc.
- Known issues and todo's - it looks a lot better if you know you have a bug, or have thought of a missing feature.
- Link to other projects you used- be a part of the community and give credit to those who made your project possible!
Here's a small example from one of my repos.
Now your turn
Even if you only implement some of these tips, you will have a more inviting github profile.
If you have any questions or thoughts, please leave a comment!
And if you think this can help someone you know - sharing is caring 🤓
Top comments (86)
Very nice! Here’s mine!
github.com/braydoncoyer
This is really impressive! Nice work!
Thank you!
Very cool profile!! Thanks for sharing!
Awesome ^^
Followed! Amazing
Nice Work Man !!
Dude, very sharp and professional.
Also seen a lot of folks, especially in frontend technologies, instead of using a photograph for their avatar, drawing or commissioning a cartoon version of their own face as the avatar, to give it a bit of originality.
That's what I do. (It's a good option for people with stalkers who still need to promote themselves safely online.)
github.com/Ismaestro really? :)
I wouldn't say that bitmoji count
asd
asd
I did mine up recently with some colourful repository banners to extend/augment the GitHub pinned repository section. They are generated in a separate repository and deployed to Netlify every hour to keep them loading fast and also update the stars and download counts of my projects. The colours are (mostly) determined from the icons in the projects. Really happy with how it turned out: github.com/Turnerj
After seeing a few others in the comments thread, I think there are a few more things I might do to make mine more interesting - probably a main banner at the top of some sort.
Wow, looks really good!!!
@james Pretty cool!
"get over yourself and do it" General advice, including Github profiles.
I've hired dozens of developers, and Github gets a passing glance. It's aspirational, usually passion projects. Great context of the sort of technology you are into in your spare time.
What hiring managers are looking for:
All that said, if you are a student, or entry level, by all means build a Github portfolio of projects. Build something useful and functional. Don't stress over squashing commits and looking like a genius in your git history. Software development is messy, and fun.
Hi Brian! I am on the other side of the spectrum, definitely not a student but a lifetime learner (well, if one is not a lifetime learner one is cooked after some age), definitely very experienced, but looking for collaboration to port my current GUI techniques on the web. I would appreciate if you could give me some feedback on mine: github.com/nilostolte
Agreed with all point. recently I also customized my github profile too...
Could you verify, it is better ?
github.com/sarveshprajapati
hey Sarvesh! thanks for the comment. Your profile looks really good!!!
I didn't understand the first line though (Lerning=Learning?)
Oh man... that minor mistake. Thanks to point out... I will update it :)
Amazing post!
Have a look at mine
github.com/iDCoded
Very cool interactive banner!
Thanks!
I'm glad you liked it.
Btw it has my name in binary ;)
Thanks for sharing these important points.
Here's my github profile for you guys to check: github.com/gchammas23
Let me know what you guys think! I'll take all your comments into consideration
Hi Sarit, This blog is beautifully written. I have my GitHub repo - github.com/sagar-barapatre.
Any helpful advice would be extremely appreciated.
Thanks!
Your github profile looks good!! And your portfolio site looks great as well!! Maybe you can display the link to it first?
I like this alot! It's such an easy way to look a project look complete on github.
No more next.js default readme's, thank you!
Agreed. It really makes it somehow more "real" and finished :) and easier to start and browse
That's a good term for it, 'real'.
The times I've come across skeleton readmes, it just registers in my head that I'm looking at some weekend throw-away project.
I even add pictures and cool visualizations with highlighted blog posts, client engagements, and more @see gitHub.com/thomasburleson
Very cool!! Love all the visulaizations!
Some comments may only be visible to logged-in visitors. Sign in to view all comments.