First Impressions Count - Why Doesn't Your Github Repo Have a README File?
Learn how to create a README file for your Github repo to make a good impression to potential employers.
Jennifer Bland
You only get one chance to make a positive first impression. For software engineers, the README file in your Github repo is your one chance to make a good impression to potential employers. Is your README file leaving the wrong impression?
The Most Important Code Isn’t Code
If your readme file does not define what your code does, then most users will just skip right over it. In other words, you failed at your chance of making a positive first impression.
What Makes a Good README file?
Description
I would recommend using short sentences in your description. You can use a bulleted list if you want. Lengthwise it should be between 3–7 sentences long coupled into 1–2 paragraphs.
How to Install
Github markdown gives you the option to highlight code. I suggest you use this to provide the exact steps needed to install your code.
Making your README file Great
Technology Stack and Versions
Live Demonstration
It is easy to upload your code to free sites like Heroku, Azure or Cloud9. Provide a link in your README file so people can click on the link and see your code in action. Make sure to put the link also in the website field in the description of your repo.
Contributing Guidelines
License
Screenshots
Authors & Contributors
Table of Contents
Testing
Example of a Great README File
Example Using EJS Templating in Node.js Application
Learn how to use EJS templating in a Node.js application.
Grid to List Toggle Using Flexbox
Learn how to create a toggle to display items in a grid from a list. This will be using basic JavaScript skills with no external code or libraries. We will be using Flexbox.