As a new developer some potential employers are going to review your Github profile as part of the interview process. This doc covers some tips that should help you make a good impression. What this doc won't do is polish a turd.
Think of your experiences reviewing a Gem or other JS library on Github. Where do you look first? The README of course. What makes for a frustrating repo? One that doesn't:
- include a README.
- include install instructions (if applicable)
- include plenty of usage examples
- describe the philosophy or approach to the tool or library.
Other things to consider including in your README:
- screenshots (not applicable for all repos)
- link to a demo site
- instructions to running the tests (test these on another computer. they should be as easy as a single copy & paste)
- tips on submitting a pull request
- Travis CI & Coveralls
- contact info (twitter/email)
A cluttered profile isn't going to impress anyone. An interviewer is usually pressed for time and doesn't want to hunt to find your best work. So make it easy for them by removing:
- un-modified forks
- totally empty repos
Have your friends follow you on Github and star the repos you'd like to have float to the top.
As a reviewer, I can't see your progress I'm less inclined to believe this work honestly represents you. Remember when your teachers required that you show your work on tests? It's very frustrating to review a repo with a single commit. The history is a great way to see how you work, how you've grown and how you think. Don't deny a reviewer that chance!
I love reviewing small projects. It's daunting to sit down and grok a rails app. I'm less likely to clone and run a big app than a small one (another reason to create a live demo site if possible).
Don't think 100-500 lines in your favorite language is any less impressive than a Rails app. In many ways a small project can be more revealing than another Rails app. You won't have a framework hide behind. Scary right?
Consider developing a Sinatra app, a Jquery plugin, a command line utility written in Ruby. Scratch an itch!
Don't have an itch? How about picking a topic you're interested in and show the world what you can learn on your own.
Let's imagine you keep hearing about "design patterns". People seem to think they're just the bees knees. Why not create a repo of markdown files describing (in your own words) all the patterns you can find. Then create examples in two languages you know for each pattern. You'll learn something and you'll probably help someone else learn that topic. If I find this repo as an interviewer, I'm going to want to bring you in for an interview.
Don't forget that as a developer you're constantly communicating. The code you write will be read, you'll interact with stakeholders, you'll be developing technical specs with other teams. So teaching is a great way to demonstrate to me that you've got great communication skills. (notice how I've published this doc?)
I'd fight to get the most passionate candidate on my team. That doesn't mean the most technically adept or experienced candidate. So show me that you're continuing to learn an participate in the community. Demonstrate that you're progressing.
In the first sentence of the second-to-last paragraph, the seventh word should be 'you're' instead of 'your.' Thanks for all the tips, Nate!