Skip to content

Commit 862615d

Browse files
authored
Merge pull request #74 from unixorn/add-linear-history-article
Add linear history article
2 parents 8f86131 + 272a8b3 commit 862615d

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
A zsh plugin that packages some extra git helper scripts I've found. I only wrote a few of these scripts, and the ones I didn't each have whatever licensing is included in the file.
1010

11-
This collection doesn't actually require zsh, but packaging it as a ZSH plugin makes it more convenient for people using a ZSH framework to use this collection.
11+
This collection doesn't actually require ZSH, but packaging it as a ZSH plugin makes it more convenient for people using a ZSH framework to use this collection.
1212

1313
If you wrote one of these scripts and want it removed from this collection, please either make a PR and/or file an issue against the repo and I will remove it.
1414

@@ -35,14 +35,14 @@ If you wrote one of these scripts and want it removed from this collection, plea
3535

3636
### Pre-requisites
3737

38-
A relatively recent version of git. The version of git Apple includes in macOS is stale. `brew install git` if you're on macOS.
38+
A relatively recent version of `git`. The version of `git` Apple includes in macOS is very stale. You should really `brew install git` to get the current version if you're on macOS.
3939

4040
### Antigen
4141

4242
If you're using [Antigen](https://github.com/zsh-users/antigen):
4343

4444
1. Add `antigen bundle unixorn/git-extra-commands` to your `.zshrc` where you've listed your other plugins.
45-
2. Close and reopen your Terminal/iTerm window to **refresh context** and use the plugin. Alternatively, you can run `antigen bundle unixorn/git-extra-commands` in a running shell to have antigen load the new plugin.
45+
2. Close and reopen your Terminal/iTerm window to **refresh context** and use the plugin. Alternatively, you can run `antigen bundle unixorn/git-extra-commands` in a running shell to have `antigen` load the new plugin.
4646

4747
### oh-my-zsh
4848

@@ -75,7 +75,7 @@ If you're using [zgen](https://github.com/tarjoilija/zgen):
7575

7676
Nothing here actually requires you to use ZSH or zgen, that's just a convenient distribution method for anyone using a ZSH framework.
7777

78-
If you aren't using any zsh frameworks, or if you're a bash user, do the following steps:
78+
If you aren't using any ZSH frameworks, or if you're a `bash` user, do the following steps:
7979

8080
1. git clone this repository
8181
2. Add `cloneDirectory/bin` to your `$PATH`.
@@ -183,7 +183,7 @@ Here are some helpful aliases for your `~/.gitconfig`
183183

184184
* Scott Chacon's [Pro Git](http://git-scm.com/book) book is a great resource for getting more out of git.
185185

186-
* Zach Dennis has a great [blog post](http://www.mutuallyhuman.com/blog/2012/06/22/a-git-walkthrough/) - it's worth reading on it's own, but here are a couple of good sites I found through it:
186+
* Zach Dennis has a great blog post - [A Git Walkthrough](http://www.mutuallyhuman.com/blog/2012/06/22/a-git-walkthrough/) - it's worth reading on it's own, but here are a couple of good sites I found through it:
187187
* [gitready.com/](http://gitready.com/) is another great reference which has been collecting information and tips for git since 2009.
188188
* [gitimmersion.com/](http://gitimmersion.com/)
189189

@@ -195,7 +195,7 @@ Here are some helpful aliases for your `~/.gitconfig`
195195

196196
* [git-tips/tips](https://github.com/git-tips/tips) is a collection of git tips
197197

198-
* Christian Neukirchen wrote a great [blog post](http://chneukirchen.org/blog/archive/2013/01/a-grab-bag-of-git-tricks.html) on git that is the source for several scripts in this collection.
198+
* Christian Neukirchen wrote a great blog post, [A Grab Bag of Git Tricks](http://chneukirchen.org/blog/archive/2013/01/a-grab-bag-of-git-tricks.html) on git that is the source for several scripts in this collection.
199199

200200
* Mislav Marohnić has a good article on git tips on his [blog](http://mislav.net/2010/07/git-tips/). Several of his git scripts are in this collection.
201201

@@ -213,6 +213,8 @@ Here are some helpful aliases for your `~/.gitconfig`
213213

214214
* [How to Review a Merge Commit](https://haacked.com/archive/2014/02/21/reviewing-merge-commits/) - Good article on dealing with reviewing the changes made during a merge.
215215

216+
* [A Tidy, Linear Git History](http://www.bitsnbites.eu/a-tidy-linear-git-history/) - Marcus Geelnard wrote a blog post about the value of a linear commit history.
217+
216218
### External Git Utilities
217219

218220
* [bfg repo-cleaner](https://rtyley.github.io/bfg-repo-cleaner/) - Removes large or troublesome blobs like `git filter-branch` does, but faster.
@@ -259,4 +261,4 @@ Here are some helpful aliases for your `~/.gitconfig`
259261
## Contributing
260262

261263
* Please include an entry in the credits section of README.md for any scripts in your PRs so authors get their work credited correctly.
262-
* Please use `#!/usr/bin/env interpreter` instead of a direct path to the interpreter, this makes it easier for people to use more recent versions when the ones packaged with their OS (macOS and CentOS, I'm looking at you) are stale.
264+
* Please use `#!/usr/bin/env interpreter` instead of a direct path to the interpreter, this makes it easier for people to use more recent versions when the ones packaged with their OS (macOS and CentOS, I'm looking at you!) are stale.

0 commit comments

Comments
 (0)