How To Best Present Your Code

I’m sure every developer at one point in their career looks back at a GitHub repo in despair, I know for sure I have. Messy commit messages, poorly named variables, and clutter that should have been refactored out long, long ago. In this article, I’m going to cover a number of pointers that will help keep your code looking appealing to employers and your fellow dev’s happy. I will be focusing more so on presentation and workflow apposed to tech specifics, however, I may touch on a few things here and there.

As developers are well aware GitHub will be the most likely place their code will live in the public eye and we all want to make a good impression to our potential employers and fellow dev’s, in many cases it is our CV/resume.

So how do we show our code in a professional manner?

Have an informative README!

One large mistake I had been making prior was underestimating the importance of a good quality README, after all, who doesn't love some good markdown! In your README you should ideally include the following;

• A description of what the code does and how to run it.
• What frameworks, languages, and tools you used.
• A brief explanation of your process and how you came to your solutions (did you use TDD?).