Write clear READMEs to increase your chances to find your first coding job
Why a developer should invest her time to write a clear README for their public repositories
In this article, I would like to share with you my little observations on how many junior developers failed to convince me to hire them by not putting a README to their repositories.
Useful links on how to craft a stunning README at the end of the article.
What is README?
Usually, README is a file in the repository of software/project that briefly explains it.
README file is there to pitch your work.
README is not your documentation (unless it can be fitted into one page).
Why should you make it?
If you make your repository public, you most likely will be judged by it. Especially, when you apply for a new job with your GitHub/GitLab account in your resume.
I have been involved in hiring interns/junior software engineering positions a few times throughout my career. On average, I saw only 1 out of 7 candidates to mention their profiles on GitHub/GitLab. Very few of those candidates would have a README attached to their repositories.
