Curtis Explains the Joke
I intentionally included a lot of fun Github Red Flags in this comic.
node_modules, .idea, .DS_Store
It is considered a coding faux-pas to include any of the following in your repo:
- generated files (the output of a scss=>css transformation)
- the output of compilation (a
- external libraries (a
- editor files (a
.idea, or Visual Studio customizations)
- unrelated files from your operating system.
Bad Commit Messages
asdfjkl;a is a terrible commit message.
Very Big Commits
asdfjkl;a also touches a lot of files. There are lots of reasons why small commits are a good idea. The biggest ones for me, though, is that it makes commit messages more readable and it makes rebasing way easier.
utils, tools, misc, stuff, things
These words all mean the same thing: "I could not think of a good name for this." Try your best to think of a better name. Try your best to remove these words from your vocabulary. You can do it. You will write better code for it. Read Clean Code. Remember that there are only two hard things in Computer Science: cache invalidation, naming things, and off-by-one-errors.
Say it with me, now: Every repo needs a readme! It should explain what the project is, any dependencies, how to install it, how to run it, and what it will do when it is run, at the very least.
Do you have more Github Red Flags? Tweet them at me, @classam!
Sparky: So, what do you think of my new project? Pretty sweet, huh? |
A github repository: sparkyzhang/awesome_cms. Description: 'finally, a CMS that rocks."
39 commits, 1 branch. Most recent commit: ASDFJKL;A. Folders include 'node_modules', 'file___0_split', '.idea', and 'midi_files'.
Files include 'index.js', 'misc.js', 'stuff.js', 'utils.js', 'things.js', and '.DS_Store'.
There is no readme. |
Cube Drone: Yeah, it's ... great. Good effort.