How to professionalize your GitHub repo

You probably know that most code professionals use GitHub, and you probably realize that people are going to look at your GitHub repos when they are thinking about whether to hire you or offer you an internship.

(If you’re not using GitHub yet, it’s easy to get started with the free GitHub Desktop app and the Atom code editor.)

GitHub’s lovable octocat mascot

Here’s how to make any GitHub repo more professional:

• Add a .gitignore file. This prevents unnecessary files from being uploaded to GitHub, even though you keep those files in the repo folder on your computer. Read how to make one. (Also, there are templates.)
• Add a LICENSE file. This specifies how (or if) people can use your files. It’s easy to create one. Without a license in your repo, your files are not truly open source!
• Add a requirements.txt file. This lets people easily download all the dependencies needed to run your code. This file is very simple to create and to use. (You will only need this for Python code.)
• Add a description, a link to live pages (maybe on github.io — a k a GitHub Pages) and topics.

• Write and add a proper README.md file. Use GitHub’s flavor of Markdown (slight differences from generic Markdown). This is super easy. The purpose of the README is to explain what’s in your repo, what it does, and how to use it. Make sure to use headings intelligently — it makes the document so much more readable.
• Last but far from least, name your repo appropriately. Short and descriptive is the way to go. Notice that most repo names are all lowercase, with hyphens. The repo name is the same as the folder name on your computer. (If you rename an existing repo on GitHub, your GitHub Desktop app will certainly get confused!)

To get started on GitHub, use GitHub’s own Hello World guide!

Mindy McAdams is macloo on GitHub.

Photo credits: (1) Striped_bow_tie.jpg, by Pete. Derivative work: Themightyquill (This file was derived from Striped bow tie.jpg) [CC BY 2.0] via Wikimedia Commons. (2) Octocat: GitHub. (3) Screenshot: Mindy McAdams.