It's 871 words long and the reading time is about 4 minutes.
This article was published on September 23, 2019.
I've been slinging code for nearly 20 years now. I've navigated the murky waters of version control, starting with CVS, Subversion, Perforce, and Git; with the latter being my de-facto since around 2010.
Mild Rant About Git
Git isn't the version control system I want, but it is the version control system I have. I won't complain too much, but why does Git require an email address to identify authors and why can't a commit have multiple authors? Pfft.
firmly believe that we're stuck with Git. The only company that can change that is GitHub; providing a newer better VCS that would allow interoperability with Git while we all migrate over.
Will that ever happen? Doubtful 😞
I'll pin this with #todo and, eventually, I'll have my GatsbyJS set-up provide a list of articles I've still to write based on #todo.
Clone to Where?
First, we'll start with the simplest of concerns: I clone all my repositories to
~/Code/src. This is also my
GOPATH. For Go developers, this is likely unsurprising.
I used to keep my Go projects and other code in separate directories, but eventually this become quite natural to adopt the "Go way".
~/Code/src is a directory for every host that I clone repositories from. Inside their, orgs/usernames. Inside them, individual repositories.
It looks like this:
01~/Code/src:0203├── aur.archlinux.org04│ ├── fluxlang05│ ├── pulumi-bin06│ └── yay07├── github.com08│ ├── chaoss09│ │ └── augur10│ ├── influxdata11│ │ ├── flux12│ │ ├── influxdb13│ │ ├── telegraf14│ ├── pulumi15│ │ └── pulumi16│ ├── rawkode17│ │ ├── dotfiles18│ │ ├── influxdb-examples19│ │ ├── kubernetes-workshop20│ │ ├── modern-life21│ │ ├── php-stat-influxdb22│ │ └── saltstack-dotfiles23└── golang.org24 └── x25 ├── lint26 └── tools27
The Actual Cloning
There are two rules when cloning repositories:
- Clone Over HTTPs
- Never clone a fork directly
Clone Over HTTPS
I'm a rather cautious person. I've got into the habit of only cloning public repositories over HTTPs so that I never accidentally push to master. Even if I don't own the repository, i've made this my default and it keeps me sane.
NB: This is a "whenever possible" rule. For private repositories, you will need to use ssh cloning; so always adopt the rule below too.
Never Clone a Fork Directly
If you fork a repository, always clone the origin first.
As an example. I have a fork of my companies primary product, InfluxDB.
I clone this with
git clone https://github.com/influxdb/influxdb
I then add my fork as a remote with
git remote add rawkode firstname.lastname@example.org:rawkode/influxdb
Now, when you've made your awesome changes to some OSS project; you push with
git push rawkode. Simples! :tada:
GitHub has a cool CLI command called
hub that allows you perform the above with
Working with Git
Now that I've got lots of code available to work on, how do I work with it?
I always ensure that I sign my commits with my GPG key. If you aren't comfortable provisioning your own GPG key, checkout Keybase.
Very little is required to configure GPG signing. Some people specify their key in the config, but as I only have one secret key available locally, as you probably will too, it's not required.
1[gpg]2 program = gpg3[commit]4 gpgsign = true5
My Git commits are terrible. I've been using a template lately to remind myself when the commit screen pops up that I should do better.
1[commit]2 template = ~/.git/templates/commit3
1feat: add hat wobble2^--^ ^------------^3| |4| +-> Summary in present tense.5|6+-------> Type: chore, docs, feat, fix, refactor, style, or test.7
I use VSCode for all my editing now, even Git commits 🙂
1[core]2 editor = code --wait3
Here are some of my favourite aliases.
I really like dislike merge commits. So much so, I always do a pull with a rebase to neatly, and cleanly, merge in missing changes; keeping my commits at the top.
1[alias]2 pl = pull --rebase3
Ever committed something and forgot to add a file? Ever committed a fix that wasn't actually the fix and then had to add a new commit with the actual fix? Yep. You need
This will add / stage changes and add them to your previous commit.
1[alias]2 cane = commit --amend --no-edit3
These are all rather simple short cuts.
1[alias]2 cm = commit -v3 co = checkout4 ps = push5 st = status6
That's it! That's "How I Git" 🙂 If you found this useful, let me know on Twitter and I'll follow up some with new Git tips.
Thanks for reading 👋🏻