From 2299a049baa92e79345d8dec59565c4ebcd4b246 Mon Sep 17 00:00:00 2001 From: Rafal Chmiel Date: Mon, 14 Apr 2014 14:42:08 +0100 Subject: [PATCH 1/8] Add section on rendered prose diffs :cat: --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 5b077d5..efde86a 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@ All the hidden and not hidden features of Git and GitHub. This cheat sheet was i - [Comparing Branches](#comparing-branches) - [Line Highlighting in Repos](#line-highlighting-in-repos) - [Metadata and Plugin Support for GitHub Pages](#metadata-and-plugin-support-for-github-pages) +- [Rendered Prose Diffs](#rendered-prose-diffs) - [Emojis](#emojis) - [Images/GIFs](#imagesgifs) - [Quick Quoting](#quick-quoting) @@ -303,6 +304,13 @@ The Jemoji and jekyll-mentions plugins enable [emoji](#emojis) and [@mentions](h [*Read more about repository metadata and plugin support for GitHub Pages.*](Repository metadata and plugin support for GitHub Pages) +## Rendered Prose Diffs +Commits and pull requests including prose files feature *source* and *rendered* views. Click the "rendered" button to see the changes as they'll appear in the rendered document. Rendered prose view is handy when you're adding, removing, and editing text: + +![Rendered Prose Diffs](https://f.cloud.github.com/assets/17715/2003056/3997edb4-862b-11e3-90be-5e9586edecd7.png) + +[*Read more about rendered prose diffs.*](https://github.com/blog/1784-rendered-prose-diffs) + ## Emojis Emojis can be generated on Pull Requests, Issues, Commit Messages, READMEs, etc. using `:name_of_emoji:` From 41bdc9dda85a581ba85f63420cd260a867bb998f Mon Sep 17 00:00:00 2001 From: Rafal Chmiel Date: Mon, 14 Apr 2014 14:47:24 +0100 Subject: [PATCH 2/8] Add section on cool :octocat: diffable maps --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index efde86a..d96042e 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,7 @@ All the hidden and not hidden features of Git and GitHub. This cheat sheet was i - [Line Highlighting in Repos](#line-highlighting-in-repos) - [Metadata and Plugin Support for GitHub Pages](#metadata-and-plugin-support-for-github-pages) - [Rendered Prose Diffs](#rendered-prose-diffs) +- [Diffable Maps](#diffable-maps) - [Emojis](#emojis) - [Images/GIFs](#imagesgifs) - [Quick Quoting](#quick-quoting) @@ -311,6 +312,11 @@ Commits and pull requests including prose files feature *source* and *rendered* [*Read more about rendered prose diffs.*](https://github.com/blog/1784-rendered-prose-diffs) +## Diffable Maps +Any time you view a commit or pull request on GitHub that includes geodata, GitHub will render a visual representation of what was changed. + +[![Diffable Maps](https://f.cloud.github.com/assets/282759/2090660/63f2e45a-8e97-11e3-9d8b-d4c8078b004e.gif)](https://github.com/benbalter/congressional-districts/commit/2233c76ca5bb059582d796f053775d8859198ec5) + ## Emojis Emojis can be generated on Pull Requests, Issues, Commit Messages, READMEs, etc. using `:name_of_emoji:` From e062f45c2e2ac4c307774150f790480543d99a31 Mon Sep 17 00:00:00 2001 From: Rafal Chmiel Date: Mon, 14 Apr 2014 14:48:20 +0100 Subject: [PATCH 3/8] Add link to diffable maps blog post --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index d96042e..ac590d8 100644 --- a/README.md +++ b/README.md @@ -317,6 +317,8 @@ Any time you view a commit or pull request on GitHub that includes geodata, GitH [![Diffable Maps](https://f.cloud.github.com/assets/282759/2090660/63f2e45a-8e97-11e3-9d8b-d4c8078b004e.gif)](https://github.com/benbalter/congressional-districts/commit/2233c76ca5bb059582d796f053775d8859198ec5) +[*Read more about diffable maps.*](https://github.com/blog/1772-diffable-more-customizable-maps) + ## Emojis Emojis can be generated on Pull Requests, Issues, Commit Messages, READMEs, etc. using `:name_of_emoji:` From 60a542c4795378c850cec8316ee69fd79b9d7d38 Mon Sep 17 00:00:00 2001 From: Rafal Chmiel Date: Mon, 14 Apr 2014 14:50:38 +0100 Subject: [PATCH 4/8] Add 'diffs' section --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ac590d8..116281e 100644 --- a/README.md +++ b/README.md @@ -21,8 +21,9 @@ All the hidden and not hidden features of Git and GitHub. This cheat sheet was i - [Comparing Branches](#comparing-branches) - [Line Highlighting in Repos](#line-highlighting-in-repos) - [Metadata and Plugin Support for GitHub Pages](#metadata-and-plugin-support-for-github-pages) -- [Rendered Prose Diffs](#rendered-prose-diffs) -- [Diffable Maps](#diffable-maps) +- [Diffs](#diffs) + - [Rendered Prose Diffs](#rendered-prose-diffs) + - [Diffable Maps](#diffable-maps) - [Emojis](#emojis) - [Images/GIFs](#imagesgifs) - [Quick Quoting](#quick-quoting) @@ -305,14 +306,15 @@ The Jemoji and jekyll-mentions plugins enable [emoji](#emojis) and [@mentions](h [*Read more about repository metadata and plugin support for GitHub Pages.*](Repository metadata and plugin support for GitHub Pages) -## Rendered Prose Diffs +## Diffs +### Rendered Prose Diffs Commits and pull requests including prose files feature *source* and *rendered* views. Click the "rendered" button to see the changes as they'll appear in the rendered document. Rendered prose view is handy when you're adding, removing, and editing text: ![Rendered Prose Diffs](https://f.cloud.github.com/assets/17715/2003056/3997edb4-862b-11e3-90be-5e9586edecd7.png) [*Read more about rendered prose diffs.*](https://github.com/blog/1784-rendered-prose-diffs) -## Diffable Maps +### Diffable Maps Any time you view a commit or pull request on GitHub that includes geodata, GitHub will render a visual representation of what was changed. [![Diffable Maps](https://f.cloud.github.com/assets/282759/2090660/63f2e45a-8e97-11e3-9d8b-d4c8078b004e.gif)](https://github.com/benbalter/congressional-districts/commit/2233c76ca5bb059582d796f053775d8859198ec5) From 7ed1ce6711076328feef0197df461496f9b1cb53 Mon Sep 17 00:00:00 2001 From: Rafal Chmiel Date: Mon, 14 Apr 2014 14:54:46 +0100 Subject: [PATCH 5/8] Add section on 'Expanding Context in Diffs' --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 116281e..8a5b320 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ All the hidden and not hidden features of Git and GitHub. This cheat sheet was i - [Diffs](#diffs) - [Rendered Prose Diffs](#rendered-prose-diffs) - [Diffable Maps](#diffable-maps) + - [Expanding Context in Diffs](#expanding-context-in-diffs) - [Emojis](#emojis) - [Images/GIFs](#imagesgifs) - [Quick Quoting](#quick-quoting) @@ -321,6 +322,13 @@ Any time you view a commit or pull request on GitHub that includes geodata, GitH [*Read more about diffable maps.*](https://github.com/blog/1772-diffable-more-customizable-maps) +### Expanding Context in Diffs +Using the *unfold* button in the gutter of a diff, you can reveal additional lines of context with a click. You can keep clicking *unfold* until you've revealed the whole file, and the feature is available anywhere GitHub renders diffs. + +![Expanding Context in Diffs](https://f.cloud.github.com/assets/22635/1610539/863c1f64-5584-11e3-82bf-151b406a272f.gif) + +[*Read more about expanding context in diffs.*](https://github.com/blog/1705-expanding-context-in-diffs) + ## Emojis Emojis can be generated on Pull Requests, Issues, Commit Messages, READMEs, etc. using `:name_of_emoji:` From 5013fc2ebabd7e6b73b86dd7a72e4dc6875a658d Mon Sep 17 00:00:00 2001 From: Rafal Chmiel Date: Mon, 14 Apr 2014 15:12:28 +0100 Subject: [PATCH 6/8] Wrap file names in code quotes + add example to Git.io --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8a5b320..8b52507 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ All the hidden and not hidden features of Git and GitHub. This cheat sheet was i - [Hub - Git Wrapper](#hub---git-wrapper) - [Decreasing Contributor Friction](#decreasing-contributor-friction) - [Previous Branch](#previous-branch) -- [git.io](#gitio) +- [Git.io](#gitio) - [Gists](#gists) - [Keyboard Shortcuts](#keyboard-shortcuts) - [Closing Issues with Commits](#closing-issues-with-commits) @@ -35,7 +35,7 @@ All the hidden and not hidden features of Git and GitHub. This cheat sheet was i - [Quick Licensing](#quick-licensing) - [Task Lists](#task-lists) - [Relative Links](#relative-links) -- [.gitconfig Recommendations](#gitconfig-recommendations) +- [`.gitconfig` Recommendations](#gitconfig-recommendations) - [Aliases](#aliases) - [Auto-correct](#auto-correct) - [Color](#color) @@ -104,11 +104,19 @@ $ git checkout - [*Read more about Git branching.*](http://git-scm.com/book/en/Git-Branching-Basic-Branching-and-Merging) -## git.io +## Git.io -[git.io](http://git.io) is a simple URL shortener for GitHub. +[Git.io](http://git.io) is a simple URL shortener for GitHub. You can also use it via pure HTTP using Curl: -[http://git.io/wO0xUg](http://git.io/wO0xUg) +```bash +$ curl -i http://git.io -F "url=https://github.com/..." +HTTP/1.1 201 Created +Location: http://git.io/abc123 + +$ curl -i http://git.io/abc123 +HTTP/1.1 302 Found +Location: https://github.com/... +``` [*Read more about Git.io.*](https://github.com/blog/985-git-io-github-url-shortener) @@ -490,7 +498,7 @@ Using relative links makes your documentation easily stand on its own. [*Read more about relative links.*](https://help.github.com/articles/relative-links-in-readmes) -## .gitconfig Recommendations +## `.gitconfig` Recommendations Your `.gitconfig` is the file that contains all your preferences. From 489da3223a74fa88ee78e9f296134812a1da0d4a Mon Sep 17 00:00:00 2001 From: Rafal Chmiel Date: Mon, 14 Apr 2014 15:15:50 +0100 Subject: [PATCH 7/8] Add example of cross-link issues --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8b52507..b0f8ad9 100644 --- a/README.md +++ b/README.md @@ -209,12 +209,14 @@ and even fetch them automatically, if you add corresponding lines in your .git/c [*Read more about checking out pull requests locally.*](https://help.github.com/articles/checking-out-pull-requests-locally) -## Cross-link Issues +## Cross-Link Issues If you want to link to another issue in the same repo, simple type hash `#` then the issue number, it will be auto-linked. To link to an issue in another repo, `user_name/repo_name#ISSUE_NUMBER` e.g. `tiimgreen/toc#12`. +![Cross-Link Issues](https://camo.githubusercontent.com/447e39ab8d96b553cadc8d31799100190df230a8/68747470733a2f2f6769746875622d696d616765732e73332e616d617a6f6e6177732e636f6d2f626c6f672f323031312f736563726574732f7265666572656e6365732e706e67) + ## Syntax Highlighting in Markdown Files For example, to syntax highlight Ruby code in your Markdown files write: From b32ba3124215fef86cd0592fa2c6a055456c6833 Mon Sep 17 00:00:00 2001 From: Rafal Chmiel Date: Mon, 14 Apr 2014 15:18:17 +0100 Subject: [PATCH 8/8] Add link to friction/wiki --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b0f8ad9..2ffe6f6 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,7 @@ $ git clone https://github.com/tiimgreen/toc.git ## Decreasing Contributor Friction If you want people to use and contribute to your project, you need to start by answering their most basic questions. What does the project do? How do I use it? How am I allowed to use it? How do I contribute? How do I get up and running in development? How do I make sure my new features didn't break old functionality? -[Friction](https://github.com/rafalchmiel/friction) is a command line script that will check your project for common answers to these questions. This is some example output: +[Friction](https://github.com/rafalchmiel/friction) is a command line script that will check your project for common [answers to these questions](https://github.com/rafalchmiel/friction/wiki). This is some example output: [![Friction output](http://i.imgur.com/4EgpWo4.png)](https://github.com/rafalchmiel/friction)