mirror of
https://github.com/tiimgreen/github-cheat-sheet.git
synced 2025-08-11 18:34:00 +02:00
Merge branch 'master' into korean
This commit is contained in:
Shim Tw
@@ -1,31 +1,16 @@
|
||||
# Contributing
|
||||
|
||||
1. Fork it (http://github.com/tiimgreen/github-cheat-sheet/fork)
|
||||
2. Commit your changes
|
||||
3. Push changes
|
||||
4. Create new Pull Request
|
||||
1. Fork the repository.
|
||||
2. Add your section - make sure you follow the [styling](#styling) guide.
|
||||
3. Commit changes.
|
||||
4. Push your commit.
|
||||
5. Create a Pull Request.
|
||||
|
||||
## Styling
|
||||
|
||||
- Use h2 for header:
|
||||
```
|
||||
## New Feature
|
||||
```
|
||||
- Add new feature in Contents Menu in correct position
|
||||
- For internal links e.g. Contents use relative links:
|
||||
```
|
||||
- [Ignore Whitespace](#ignore-whitespace)
|
||||
```
|
||||
Not:
|
||||
```
|
||||
- [Ignore Whitespace](https://github.com/tiimgreen/github-cheat-sheet#ignore-whitespace)
|
||||
```
|
||||
- Add examples wherever possible
|
||||
- Use `bash` styling for all git commands:
|
||||
```bash
|
||||
$ git commit -m "Message"
|
||||
```
|
||||
```bash
|
||||
$ git commit -m "Message"
|
||||
```
|
||||
- Add links to Git docs or GitHub docs wherever possible
|
||||
- Use `###` headers for your sections.
|
||||
- Also use `###` for categories (these should group together relevant sections) and `####` for subcategories.
|
||||
- Add a link to your section/category to the contents section (use relative links).
|
||||
- Make sure to include examples wherever possible (preferably GIFs).
|
||||
- For command-line examples, wrap your commands in a `bash` code block. Ask [@rafalchmiel](https://github.com/rafalchmiel) or [@tiimgreen](https://github.com/tiimgreen) to take a screenshot (so that it is consistent with the rest) of the output if it has color, etc.
|
||||
- At the end of your section, add a `Read more about...` link. This should directly link to [Git's](http://git-scm.com/docs) or [GitHub's](https://help.github.com/) documentation.
|
||||
|
||||
724
README.md
724
README.md
@@ -1,54 +1,66 @@
|
||||
# GitHub Cheat Sheet
|
||||
A collection of cool hidden and not so hidden features of Git and GitHub. This cheat sheet was inspired by [Zach Holman](https://github.com/holman)'s [Git and GitHub Secrets](http://www.confreaks.com/videos/1229-aloharuby2012-git-and-github-secrets) talk at Aloha Ruby Conference 2012 ([slides](https://speakerdeck.com/holman/git-and-github-secrets)) and his [More Git and GitHub Secrets](https://vimeo.com/72955426) talk at WDCNZ 2013 ([slides](https://speakerdeck.com/holman/more-git-and-github-secrets)).
|
||||
|
||||
All the hidden and not hidden features of Git and GitHub. This cheat sheet was inspired by [Zach Holman](https://github.com/holman)'s [Git and GitHub Secrets](http://www.confreaks.com/videos/1229-aloharuby2012-git-and-github-secrets) talk at Aloha Ruby Conference 2012 ([slides](https://speakerdeck.com/holman/git-and-github-secrets)) and his [More Git and GitHub Secrets](https://vimeo.com/72955426) talk at WDCNZ 2013 ([slides](https://speakerdeck.com/holman/more-git-and-github-secrets)).
|
||||
|
||||
# Contents
|
||||
|
||||
- [Ignore Whitespace](#ignore-whitespace)
|
||||
- [Cloning a Repo](#cloning-a-repo)
|
||||
- [Hub - Git Wrapper](#hub---git-wrapper)
|
||||
- [Decreasing Contributor Friction](#decreasing-contributor-friction)
|
||||
- [Previous Branch](#previous-branch)
|
||||
- [Git.io](#gitio)
|
||||
- [Gists](#gists)
|
||||
- [Keyboard Shortcuts](#keyboard-shortcuts)
|
||||
- [Closing Issues with Commits](#closing-issues-with-commits)
|
||||
- [Checking out Pull Requests](#checking-out-pull-requests)
|
||||
- [Cross-Link Issues](#cross-link-issues)
|
||||
- [Syntax Highlighting in Markdown Files](#syntax-highlighting-in-markdown-files)
|
||||
- [Commit History by Author](#commit-history-by-author)
|
||||
- [Empty Commits](#empty-commits)
|
||||
- [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)
|
||||
- [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)
|
||||
- [Styled Git Status](#styled-git-status)
|
||||
- [Styled Git Log](#styled-git-log)
|
||||
- [Git Query](#git-query)
|
||||
- [Merged Branches](#merged-branches)
|
||||
- [Quick Licensing](#quick-licensing)
|
||||
- [Task Lists](#task-lists)
|
||||
- [Relative Links](#relative-links)
|
||||
- [`.gitconfig` Recommendations](#gitconfig-recommendations)
|
||||
## Table of Contents
|
||||
- [GitHub](#github)
|
||||
- [Ignore Whitespace](#ignore-whitespace)
|
||||
- [Commit History by Author](#commit-history-by-author)
|
||||
- [Cloning a Repository](#cloning-a-repository)
|
||||
- [Comparing Branches](#comparing-branches)
|
||||
- [Compare Branches across Forked Repositories](#compare-branches-across-forked-repositories)
|
||||
- [Gists](#gists)
|
||||
- [Git.io](#gitio)
|
||||
- [Keyboard Shortcuts](#keyboard-shortcuts)
|
||||
- [Line Highlighting in Repositories](#line-highlighting-in-repositories)
|
||||
- [Closing Issues via Commit Messages](#closing-issues-via-commit-messages)
|
||||
- [Cross-Link Issues](#cross-link-issues)
|
||||
- [Syntax Highlighting in Markdown Files](#syntax-highlighting-in-markdown-files)
|
||||
- [Emojis](#emojis)
|
||||
- [Images/GIFs](#imagesgifs)
|
||||
- [Embedding Images in GitHub Wiki](#embedding-images-in-github-wiki)
|
||||
- [Quick Quoting](#quick-quoting)
|
||||
- [Quick Licensing](#quick-licensing)
|
||||
- [Task Lists](#task-lists)
|
||||
- [Relative Links](#relative-links)
|
||||
- [Metadata and Plugin Support for GitHub Pages](#metadata-and-plugin-support-for-github-pages)
|
||||
- [Diffs](#diffs)
|
||||
- [Rendered prose Diffs](#rendered-prose-diffs)
|
||||
- [Diffable Maps](#diffable-maps)
|
||||
- [Expanding Context in Diffs](#expanding-context-in-diffs)
|
||||
- [Hub](#hub)
|
||||
- [Decreasing Contributor Friction](#decreasing-contributor-friction)
|
||||
- [Contributing Guidelines](#contributing-guidelines)
|
||||
- [Git](#git)
|
||||
- [Previous Branch](#previous-branch)
|
||||
- [Checking out Pull Requests](#checking-out-pull-requests)
|
||||
- [Empty Commits :trollface:](#empty-commits-trollface)
|
||||
- [Styled Git Status](#styled-git-status)
|
||||
- [Styled Git Log](#styled-git-log)
|
||||
- [Git Query](#git-query)
|
||||
- [Merged Branches](#merged-branches)
|
||||
- [Web Server for Browsing Local Repositories](#web-server-for-browsing-local-repositories)
|
||||
- [Git Configurations](#git-configurations)
|
||||
- [Aliases](#aliases)
|
||||
- [Auto-correct](#auto-correct)
|
||||
- [Auto-Correct](#auto-correct)
|
||||
- [Color](#color)
|
||||
|
||||
## Ignore Whitespace
|
||||
|
||||
## GitHub
|
||||
### Ignore Whitespace
|
||||
Adding `?w=1` to any diff URL will remove any changes only in whitespace, enabling you to see only that code that has changed.
|
||||
|
||||
[*Read more about GitHub secrets.*](https://github.com/blog/967-github-secrets)
|
||||
|
||||
## Cloning a Repo
|
||||
### Commit History by Author
|
||||
To view all commits on a repo by author add `?author=username` to the URL.
|
||||
|
||||
When cloning a repo the `.git` can be left off the end.
|
||||
```
|
||||
https://github.com/rails/rails/commits/master?author=dhh
|
||||
```
|
||||
|
||||
[*Read more about the differences between commits views.*](https://help.github.com/articles/differences-between-commit-views)
|
||||
|
||||
### Cloning a Repository
|
||||
When cloning a repository the `.git` can be left off the end.
|
||||
|
||||
```bash
|
||||
$ git clone https://github.com/tiimgreen/github-cheat-sheet
|
||||
@@ -56,56 +68,58 @@ $ git clone https://github.com/tiimgreen/github-cheat-sheet
|
||||
|
||||
[*Read more about the Git `clone` command.*](http://git-scm.com/docs/git-clone)
|
||||
|
||||
## Hub - Git Wrapper
|
||||
### Comparing Branches
|
||||
To use GitHub to compare branches, change the URL to look like this:
|
||||
|
||||
[Hub](https://github.com/github/hub) is a command line git wrapper that gives extra features and commands that make working with GitHub easier.
|
||||
|
||||
This allows you to do things like:
|
||||
|
||||
```bash
|
||||
$ hub clone tiimgreen/toc
|
||||
```
|
||||
https://github.com/user/repo/compare/{range}
|
||||
```
|
||||
|
||||
instead of:
|
||||
Where `{range} = master...4-1-stable`
|
||||
|
||||
```bash
|
||||
$ git clone https://github.com/tiimgreen/toc.git
|
||||
For example:
|
||||
```
|
||||
https://github.com/rails/rails/compare/master...4-1-stable
|
||||
```
|
||||
|
||||
[*Check out some more cool commands Hub has to offer.*](https://github.com/github/hub#commands)
|
||||
`{range}` can be changed to things like:
|
||||
|
||||
## 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](https://github.com/rafalchmiel/friction/wiki). This is some example output:
|
||||
|
||||
[](https://github.com/rafalchmiel/friction)
|
||||
|
||||
## Previous Branch
|
||||
|
||||
To move to the previous directory in the command line:
|
||||
|
||||
```bash
|
||||
$ cd -
|
||||
```
|
||||
https://github.com/rails/rails/compare/master@{1.day.ago}...master
|
||||
https://github.com/rails/rails/compare/master@{2014-10-04}...master
|
||||
```
|
||||
|
||||
Similarly, to move to the last branch in git:
|
||||
...which allows you to see the difference on the master branch up a set time ago or a specified date.
|
||||
|
||||
```bash
|
||||
$ git checkout -
|
||||
# Switched to branch 'master'
|
||||
[*Read more about comparing commits across time.*](https://help.github.com/articles/comparing-commits-across-time)
|
||||
|
||||
$ git checkout -
|
||||
# Switched to branch 'next'
|
||||
### Compare Branches across Forked Repositories
|
||||
To use GitHub to compare branches across forked repositories, change the URL to look like this:
|
||||
|
||||
$ git checkout -
|
||||
# Switched to branch 'master'
|
||||
```
|
||||
https://github.com/user/repo/compare/{foreign-user}:{branch}...{own-branch}
|
||||
```
|
||||
|
||||
[*Read more about Git branching.*](http://git-scm.com/book/en/Git-Branching-Basic-Branching-and-Merging)
|
||||
For example:
|
||||
|
||||
## Git.io
|
||||
```
|
||||
https://github.com/rails/rails/compare/byroot:idempotent-counter-caches...master
|
||||
```
|
||||
|
||||
### Gists
|
||||
[Gists](https://gist.github.com/) are an easy way to work with small bits of code without creating a fully fledged repository. Add `.pibb` to the end of any Gist URL ([like this](https://gist.github.com/tiimgreen/10545817.pibb)) in order to get the *HTML only* version suitable for embedding in any other site.
|
||||
|
||||
Gists can be treated as a full repository so they can be cloned like any other:
|
||||
|
||||
```bash
|
||||
$ git clone https://gist.github.com/tiimgreen/10545817
|
||||
```
|
||||
|
||||
|
||||
|
||||
[*Read more about creating gists.*](https://help.github.com/articles/creating-gists)
|
||||
|
||||
### Git.io
|
||||
[Git.io](http://git.io) is a simple URL shortener for GitHub. You can also use it via pure HTTP using Curl:
|
||||
|
||||
```bash
|
||||
@@ -120,39 +134,31 @@ Location: https://github.com/...
|
||||
|
||||
[*Read more about Git.io.*](https://github.com/blog/985-git-io-github-url-shortener)
|
||||
|
||||
## Gists
|
||||
### Keyboard Shortcuts
|
||||
When on a repository page, keyboard shortcuts allow you to navigate easily.
|
||||
|
||||
[Gists](https://gist.github.com/) are an easy way to work with small bits of code without creating a fully fledged repo.
|
||||
|
||||
Although, Gists can be treated as a full repo so they can be cloned like any other:
|
||||
```bash
|
||||
$ git clone https://gist.github.com/tiimgreen/10545817
|
||||
```
|
||||
|
||||
|
||||
|
||||
[*Read more about creating gists.*](https://help.github.com/articles/creating-gists)
|
||||
|
||||
## Keyboard Shortcuts
|
||||
|
||||
When on a repo page keyboard shortcuts allow you to navigate easily.
|
||||
|
||||
Pressing `t` will bring up a file explorer.
|
||||
|
||||
Pressing `w` will bring up the branch selector.
|
||||
|
||||
Pressing `s` will select the search bar.
|
||||
|
||||
Pressing `l` will edit labels on existing issues.
|
||||
|
||||
Pressing `y` __when looking at a file__ (e.g. `https://github.com/tiimgreen/github-cheat-sheet/blob/master/README.md`) will change your URL to one which, in effect, freezes the page you are looking at. If this code changes, you will still be able to see what you saw at that current time.
|
||||
- Pressing `t` will bring up a file explorer.
|
||||
- Pressing `w` will bring up the branch selector.
|
||||
- Pressing `s` will select the Command Bar.
|
||||
- Pressing `l` will edit labels on existing Issues.
|
||||
- Pressing `y` **when looking at a file** (e.g. `https://github.com/tiimgreen/github-cheat-sheet/blob/master/README.md`) will change your URL to one which, in effect, freezes the page you are looking at. If this code changes, you will still be able to see what you saw at that current time.
|
||||
|
||||
To see all of the shortcuts for the current page press `?`.
|
||||
|
||||
[*Read more about using the Command Bar.*](https://help.github.com/articles/using-the-command-bar)
|
||||
|
||||
## Closing Issues with Commits
|
||||
### Line Highlighting in Repositories
|
||||
Either adding `#L52` to the end of a code file URL or simply clicking the line number will highlight that line number.
|
||||
|
||||
It also works with ranges, e.g. `#L53-L60`, to select ranges, hold `shift` and click two lines:
|
||||
|
||||
```
|
||||
https://github.com/rails/rails/blob/master/activemodel/lib/active_model.rb#L53-L60
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Closing Issues via Commit Messages
|
||||
If a particular commit fixes an issue, any of the keywords `fix/fixes/fixed` or `close/closes/closed`, followed by the issue number, will close the issue once it is committed to the master branch.
|
||||
|
||||
```bash
|
||||
@@ -163,10 +169,216 @@ This closes the issue and references the closing commit.
|
||||
|
||||
|
||||
|
||||
[*Read more about closing issues via commit messages.*](https://help.github.com/articles/closing-issues-via-commit-messages)
|
||||
[*Read more about closing Issues via commit messages.*](https://help.github.com/articles/closing-issues-via-commit-messages)
|
||||
|
||||
## Checking out Pull Requests
|
||||
### Cross-Link Issues
|
||||
If you want to link to another issue in the same repository, simple type hash `#` then the issue number, it will be auto-linked.
|
||||
|
||||
To link to an issue in another repository, `user_name/repo_name#ISSUE_NUMBER` e.g. `tiimgreen/toc#12`.
|
||||
|
||||
|
||||
|
||||
### Syntax Highlighting in Markdown Files
|
||||
For example, to syntax highlight Ruby code in your Markdown files write:
|
||||
|
||||
```ruby
|
||||
require 'tabbit'
|
||||
table = Tabbit.new('Name', 'Email')
|
||||
table.add_row('Tim Green', 'tiimgreen@gmail.com')
|
||||
puts table.to_s
|
||||
```
|
||||
|
||||
This will produce:
|
||||
|
||||
```ruby
|
||||
require 'tabbit'
|
||||
table = Tabbit.new('Name', 'Email')
|
||||
table.add_row('Tim Green', 'tiimgreen@gmail.com')
|
||||
puts table.to_s
|
||||
```
|
||||
|
||||
GitHub uses [Linguist](https://github.com/github/linguist) to perform language detection and syntax highlighting. You can find out which keywords are valid by perusing the [languages YAML file](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml).
|
||||
|
||||
[*Read more about GitHub Flavored Markdown.*](https://help.github.com/articles/github-flavored-markdown)
|
||||
|
||||
### Emojis
|
||||
Emojis can added to on Pull Requests, Issues, commit messages, Markdown files, etc. using `:name_of_emoji:`:
|
||||
|
||||
```
|
||||
:smile:
|
||||
```
|
||||
|
||||
Would produce:
|
||||
|
||||
:smile:
|
||||
|
||||
The full list of supported Emojis on GitHub can be found [here](http://www.emoji-cheat-sheet.com/) or [here](https://github.com/scotch-io/All-Github-Emoji-Icons).
|
||||
|
||||
The top 5 used Ejmojis on GitHub are:
|
||||
|
||||
1. :shipit: - `:shipit:`
|
||||
2. :sparkles: - `:sparkles:`
|
||||
3. :-1: - `:-1:`
|
||||
4. :+1: - `:+1:`
|
||||
5. :clap: - `:clap:`
|
||||
|
||||
### Images/GIFs
|
||||
Images and GIFs can be added to comments, READMEs etc.:
|
||||
|
||||
```
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
All images are cached on GitHub, so if your host goes down, the image will remain available.
|
||||
|
||||
#### Embedding Images in GitHub Wiki
|
||||
There are multiple ways of embedding images in Wiki pages. There's the standard Markdown syntax (shown above). But there's also a syntax that allows things like specifying the height or width of the image:
|
||||
|
||||
```markdown
|
||||
[[ http://www.sheawong.com/wp-content/uploads/2013/08/keephatin.gif | height = 100px ]]
|
||||
```
|
||||
|
||||
Which produces:
|
||||
|
||||
|
||||
|
||||
### Quick Quoting
|
||||
When on a comment thread and you want to quote something someone previously said, highlight the text and press `r`, this will copy it into your text box in the block-quote format.
|
||||
|
||||
|
||||
|
||||
[*Read more about quick quoting.*](https://github.com/blog/1399-quick-quotes)
|
||||
|
||||
### Quick Licensing
|
||||
When creating a repository GitHub gives you the options of adding in a pre-made license:
|
||||
|
||||
|
||||
|
||||
You can also add them to existing repositories by creating a new file through the web interface. When the name `LICENSE` is typed in you will get an option to use a template:
|
||||
|
||||
|
||||
|
||||
Also works for `.gitignore`.
|
||||
|
||||
[*Read more about open source licensing.*](https://help.github.com/articles/open-source-licensing)
|
||||
|
||||
### Task Lists
|
||||
In Issues and Pull requests check boxes can be added with the following syntax (notice the space):
|
||||
|
||||
```
|
||||
- [ ] Be awesome
|
||||
- [ ] Do stuff
|
||||
- [ ] Sleep
|
||||
```
|
||||
|
||||
|
||||
|
||||
When they are clicked, they will be updated in the pure Markdown:
|
||||
|
||||
```
|
||||
- [x] Be awesome
|
||||
- [x] Do stuff
|
||||
- [ ] Sleep
|
||||
```
|
||||
|
||||
[*Read more about task lists.*](https://github.com/blog/1375%0A-task-lists-in-gfm-issues-pulls-comments)
|
||||
|
||||
### Relative Links
|
||||
Relative links are recommended in your Markdown files when linking to internal content.
|
||||
|
||||
```markdown
|
||||
[Link to a header](#awesome-section)
|
||||
[Link to a file](docs/readme)
|
||||
```
|
||||
|
||||
Absolute links have to be updated whenever the URL changes (e.g. repository renamed, username changed, project forked). 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)
|
||||
|
||||
### Metadata and Plugin Support for GitHub Pages
|
||||
Within Jekyll pages and posts, repository information is available within the `site.github` namespace, and can be displayed, for example, using `{{ site.github.project_title }}`.
|
||||
|
||||
The Jemoji and jekyll-mentions plugins enable [emoji](#emojis) and [@mentions](https://github.com/blog/821) in your Jekyll posts and pages to work just like you'd expect when interacting with a repository on GitHub.com.
|
||||
|
||||
[*Read more about repository metadata and plugin support for GitHub Pages.*](Repository metadata and plugin support for GitHub Pages)
|
||||
|
||||
### Diffs
|
||||
#### Rendered Prose Diffs
|
||||
Commits and pull requests including rendered documents supported by GitHub (e.g. Markdown) 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:
|
||||
|
||||
|
||||
|
||||
[*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.
|
||||
|
||||
[](https://github.com/benbalter/congressional-districts/commit/2233c76ca5bb059582d796f053775d8859198ec5)
|
||||
|
||||
[*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.
|
||||
|
||||
|
||||
|
||||
[*Read more about expanding context in diffs.*](https://github.com/blog/1705-expanding-context-in-diffs)
|
||||
|
||||
### Hub
|
||||
[Hub](https://github.com/github/hub) is a command line Git wrapper that gives you extra features and commands that make working with GitHub easier.
|
||||
|
||||
This allows you to do things like:
|
||||
|
||||
```bash
|
||||
$ hub clone tiimgreen/toc
|
||||
```
|
||||
|
||||
...instead of:
|
||||
|
||||
```bash
|
||||
$ git clone https://github.com/tiimgreen/toc.git
|
||||
```
|
||||
|
||||
[*Check out some more cool commands Hub has to offer.*](https://github.com/github/hub#commands)
|
||||
|
||||
### 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](https://github.com/rafalchmiel/friction/wiki). This is some example output:
|
||||
|
||||
[](https://github.com/rafalchmiel/friction)
|
||||
|
||||
### Contributing Guidelines
|
||||
Adding a `CONTRIBUTING` file to the root of your repository will add a link to your file when a contributor creates an Issue or opens a Pull Request.
|
||||
|
||||
|
||||
|
||||
[*Read more about contributing guidelines.*](https://github.com/blog/1184-contributing-guidelines)
|
||||
|
||||
## Git
|
||||
### Previous Branch
|
||||
To move to the previous branch in Git:
|
||||
|
||||
```bash
|
||||
$ git checkout -
|
||||
# Switched to branch 'master'
|
||||
|
||||
$ git checkout -
|
||||
# Switched to branch 'next'
|
||||
|
||||
$ git checkout -
|
||||
# Switched to branch 'master'
|
||||
```
|
||||
|
||||
[*Read more about Git branching.*](http://git-scm.com/book/en/Git-Branching-Basic-Branching-and-Merging)
|
||||
|
||||
### Checking out Pull Requests
|
||||
If you want to check out pull request locally, you can fetch it using that command:
|
||||
|
||||
```bash
|
||||
@@ -209,215 +421,59 @@ 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
|
||||
|
||||
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`.
|
||||
|
||||
|
||||
|
||||
## Syntax Highlighting in Markdown Files
|
||||
|
||||
For example, to syntax highlight Ruby code in your Markdown files write:
|
||||
|
||||
```ruby
|
||||
require 'tabbit'
|
||||
table = Tabbit.new('Name', 'Email')
|
||||
table.add_row('Tim Green', 'tiimgreen@gmail.com')
|
||||
puts table.to_s
|
||||
```
|
||||
|
||||
This will produce:
|
||||
|
||||
```ruby
|
||||
require 'tabbit'
|
||||
table = Tabbit.new('Name', 'Email')
|
||||
table.add_row('Tim Green', 'tiimgreen@gmail.com')
|
||||
puts table.to_s
|
||||
```
|
||||
|
||||
GitHub uses [Linguist](https://github.com/github/linguist) to perform language detection and syntax highlighting. You can find out which keywords are valid by perusing the [languages YAML file](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml).
|
||||
|
||||
[*Read more about GitHub Flavored Markdown.*](https://help.github.com/articles/github-flavored-markdown)
|
||||
|
||||
## Commit History by Author
|
||||
|
||||
To view all commits on a repo by author add `?author=username` to the URL.
|
||||
|
||||
```
|
||||
https://github.com/rails/rails/commits/master?author=dhh
|
||||
```
|
||||
|
||||
[*Read more about the differences between commits views.*](https://help.github.com/articles/differences-between-commit-views)
|
||||
|
||||
## Empty Commits
|
||||
|
||||
Commits can be pushed with no code changes by adding `--allow-empty`
|
||||
### Empty Commits :trollface:
|
||||
Commits can be pushed with no code changes by adding `--allow-empty`:
|
||||
|
||||
```bash
|
||||
$ git commit -m "Big-ass commit" --allow-empty
|
||||
```
|
||||
|
||||
|
||||
Some use-cases for this (that make sense), include:
|
||||
|
||||
## Comparing Branches
|
||||
- Annotating the start of a new bulk of work or a new feature.
|
||||
- Documenting when you make changes to the project that aren't code related.
|
||||
- Communicating with people using your repository.
|
||||
|
||||
To use GitHub to compare branches, change the URL to look like this:
|
||||
|
||||
```
|
||||
https://github.com/user/repo/compare/{range}
|
||||
```
|
||||
|
||||
Where `{range} = master...4-1-stable`
|
||||
|
||||
e.g.:
|
||||
```
|
||||
https://github.com/rails/rails/compare/master...4-1-stable
|
||||
```
|
||||
|
||||
`{range}` can be changed to things like:
|
||||
```
|
||||
https://github.com/rails/rails/compare/master@{1.day.ago}...master
|
||||
https://github.com/rails/rails/compare/master@{2014-10-04}...master
|
||||
```
|
||||
which allows you to see the difference on the master branch up a set time ago or a specified date.
|
||||
|
||||
[*Read more about comparing commits across time.*](https://help.github.com/articles/comparing-commits-across-time)
|
||||
|
||||
### Compare branches across forked repositories
|
||||
|
||||
To use GitHub to compare branches across forked repositories, change the URL to look like this:
|
||||
|
||||
```
|
||||
https://github.com/user/repo/compare/{foreign-user}:{branch}...{own-branch}
|
||||
```
|
||||
|
||||
eg.:
|
||||
```
|
||||
https://github.com/rails/rails/compare/byroot:idempotent-counter-caches...master
|
||||
```
|
||||
|
||||
## Line Highlighting in Repos
|
||||
|
||||
Either adding `#L52` to the end of a code file URL or simply clicking the line number will highlight that line number.
|
||||
|
||||
It also works with ranges, e.g. `#L53-L60`, to select ranges, hold `shift` and click two lines:
|
||||
|
||||
```
|
||||
https://github.com/rails/rails/blob/master/activemodel/lib/active_model.rb#L53-L60
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Metadata and Plugin Support for GitHub Pages
|
||||
Within Jekyll pages and posts, repository information is available within the `site.github` namespace, and can be displayed, for example, using `{{ site.github.project_title }}`.
|
||||
|
||||
The Jemoji and jekyll-mentions plugins enable [emoji](#emojis) and [@mentions](https://github.com/blog/821) in your Jekyll posts and pages to work just like you'd expect when interacting with a repository on GitHub.com.
|
||||
|
||||
[*Read more about repository metadata and plugin support for GitHub Pages.*](Repository metadata and plugin support for GitHub Pages)
|
||||
|
||||
## 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:
|
||||
|
||||
|
||||
|
||||
[*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.
|
||||
|
||||
[](https://github.com/benbalter/congressional-districts/commit/2233c76ca5bb059582d796f053775d8859198ec5)
|
||||
|
||||
[*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.
|
||||
|
||||
|
||||
|
||||
[*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:`
|
||||
|
||||
```
|
||||
:smile:
|
||||
:poop:
|
||||
:shipit:
|
||||
:+1:
|
||||
```
|
||||
|
||||
:smile:
|
||||
:poop:
|
||||
:shipit:
|
||||
:+1:
|
||||
|
||||
The full list of supported Emojis on GitHub can be found [here](http://www.emoji-cheat-sheet.com/) or [here](https://github.com/scotch-io/All-Github-Emoji-Icons).
|
||||
|
||||
The top 5 used Ejmojis on GitHub are:
|
||||
|
||||
1. :shipit: `:shipit:`
|
||||
2. :sparkles: `:sparkles:`
|
||||
3. :-1: `:-1:`
|
||||
4. :+1: `:+1:`
|
||||
5. :clap: `:clap:`
|
||||
|
||||
## Images/GIFs
|
||||
|
||||
Images and GIFs can be added to comments, READMEs etc.:
|
||||
|
||||
```
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
All images are cached on GitHub, so if your host goes down, the image will remain available.
|
||||
|
||||
## Quick Quoting
|
||||
|
||||
When on a comment thread and you want to quote something someone previously said, highlight the text and press `r`, this will copy it into your text box in the block-quote format.
|
||||
|
||||
|
||||
|
||||
[*Read more about quick quoting.*](https://github.com/blog/1399-quick-quotes)
|
||||
|
||||
## Styled Git Status
|
||||
### Styled Git Status
|
||||
Running:
|
||||
|
||||
```bash
|
||||
$ git status
|
||||
```
|
||||
|
||||
Produces:
|
||||
|
||||
|
||||
|
||||
Can be changed to:
|
||||
By adding `-sb`:
|
||||
|
||||
```bash
|
||||
$ git status -sb
|
||||
```
|
||||
|
||||
This is produced:
|
||||
|
||||
|
||||
|
||||
[*Read more about the Git `status` command.*](http://git-scm.com/docs/git-status)
|
||||
|
||||
## Styled Git Log
|
||||
### Styled Git Log
|
||||
Running:
|
||||
|
||||
```bash
|
||||
$ git log --all --graph --decorate --oneline --abbrev-commit
|
||||
```
|
||||
|
||||
Produces:
|
||||
|
||||
|
||||
|
||||
NOTE: This can be added into an Alias (shorter command) using the instructions [here](https://github.com/tiimgreen/github-cheat-sheet#aliases)
|
||||
*This can be aliased using the instructions found [here](https://github.com/tiimgreen/github-cheat-sheet#aliases).*
|
||||
|
||||
[*Read more about the Git `log` command.*](http://git-scm.com/docs/git-log)
|
||||
|
||||
## Git Query
|
||||
|
||||
A git query allows you to search all your previous commit messages and finds the most recent one matching the query.
|
||||
### Git Query
|
||||
A Git query allows you to search all your previous commit messages and find the most recent one matching the query.
|
||||
|
||||
```bash
|
||||
$ git show :/query
|
||||
@@ -430,9 +486,10 @@ $ git show :/typo
|
||||
```
|
||||
|
||||
|
||||
NOTE: Press `q` to quit.
|
||||
*Press `q` to quit.*
|
||||
|
||||
## Merged Branches
|
||||
### Merged Branches
|
||||
Running:
|
||||
|
||||
```bash
|
||||
$ git branch --merged
|
||||
@@ -450,95 +507,59 @@ Will give you a list of branches that have not been merged into your current bra
|
||||
|
||||
[*Read more about the Git `branch` command.*](http://git-scm.com/docs/git-branch)
|
||||
|
||||
## Quick Licensing
|
||||
### Web Server for Browsing Local Repositories
|
||||
Use the Git `instaweb` command to instantly browse your working repository in `gitweb`. This command is a simple script to set up `gitweb` and a web server for browsing the local repository.
|
||||
|
||||
When creating a repo GitHub gives you the options of adding in a pre-made license:
|
||||
|
||||
|
||||
|
||||
You can also add them to existing repos by creating a new file through the web interface. When the name `LICENSE` is typed in you will get an option to use a template:
|
||||
|
||||
|
||||
|
||||
Also works for `.gitignore`.
|
||||
|
||||
[*Read more about open source licensing.*](https://help.github.com/articles/open-source-licensing)
|
||||
|
||||
## Task Lists
|
||||
|
||||
In Issues and Pull requests check boxes can be added with the following syntax (notice the space):
|
||||
```
|
||||
- [ ] Be awesome
|
||||
- [ ] Do stuff
|
||||
- [ ] Sleep
|
||||
```bash
|
||||
$ git instaweb
|
||||
```
|
||||
|
||||
|
||||
Opens:
|
||||
|
||||
When they are clicked, they will be updated in the pure Markdown:
|
||||
|
||||
|
||||
```
|
||||
- [x] Be awesome
|
||||
- [x] Do stuff
|
||||
- [ ] Sleep
|
||||
```
|
||||
[*Read more about the Git `instaweb` command.*](http://git-scm.com/docs/git-instaweb)
|
||||
|
||||
[*Read more about task lists.*](https://github.com/blog/1375%0A-task-lists-in-gfm-issues-pulls-comments)
|
||||
|
||||
## Relative Links
|
||||
|
||||
Relative links are recommended in your Markdown files when linking to internal content.
|
||||
|
||||
```markdown
|
||||
[Link to a header](#awesome-section)
|
||||
|
||||
[Link to a file](docs/readme)
|
||||
```
|
||||
|
||||
Absolute links have to be updated whenever the URL changes (e.g. repo renamed, username changed, project forked).
|
||||
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
|
||||
|
||||
Your `.gitconfig` is the file that contains all your preferences.
|
||||
|
||||
### Aliases
|
||||
### Git Configurations
|
||||
Your `.gitconfig` file contains all your Git configurations.
|
||||
|
||||
#### Aliases
|
||||
Aliases are helpers that let you define your own git calls. For example you could set `git a` to run `git add --all`.
|
||||
|
||||
To add an alias, either navigate to `~/.gitconfig` and fill it out in the following format:
|
||||
|
||||
```
|
||||
[alias]
|
||||
co = checkout
|
||||
cm = commit
|
||||
p = push
|
||||
# Show verbose output about tags, branches or remotes
|
||||
tags = tag -l
|
||||
branches = branch -a
|
||||
remotes = remote -v
|
||||
co = checkout
|
||||
cm = commit
|
||||
p = push
|
||||
# Show verbose output about tags, branches or remotes
|
||||
tags = tag -l
|
||||
branches = branch -a
|
||||
remotes = remote -v
|
||||
```
|
||||
|
||||
or type in the command line:
|
||||
...or type in the command-line:
|
||||
|
||||
```bash
|
||||
$ git config alias.new_alias git_function
|
||||
```
|
||||
e.g.
|
||||
|
||||
For example:
|
||||
|
||||
```bash
|
||||
$ git config alias.cm commit
|
||||
```
|
||||
|
||||
NOTE: for an alias with multiple functions use quotes:
|
||||
For an alias with multiple functions use quotes:
|
||||
|
||||
```bash
|
||||
$ git config alias.ac 'add -A . && commit'
|
||||
```
|
||||
|
||||
Some recommendations include:
|
||||
Some useful aliases include:
|
||||
|
||||
| Alias | Current Command | What to Type |
|
||||
| Alias | Command | What to Type |
|
||||
| --- | --- | --- |
|
||||
| `git cm` | `git commit` | `git config --global alias.cm commit` |
|
||||
| `git co` | `git checkout` | `git config --global alias.co checkout` |
|
||||
@@ -548,24 +569,24 @@ Some recommendations include:
|
||||
| `git branches` | `git branch -a` | `git config --global alias.branches 'branch -a'` |
|
||||
| `git remotes` | `git remote -v` | `git config --global alias.remotes 'remote -v'` |
|
||||
|
||||
### Auto-correct
|
||||
#### Auto-Correct
|
||||
If you type `git comit` you will get this:
|
||||
|
||||
Currently if you type `git comit` you will get this result:
|
||||
```bash
|
||||
$ git comit -m "Message"
|
||||
# git: 'comit' is not a git command. See 'git --help'.
|
||||
|
||||
# Did you mean this?
|
||||
# commit
|
||||
# commit
|
||||
```
|
||||
|
||||
To call `commit` when `comit` is typed, just enable autocorrect:
|
||||
To call `commit` when `comit` is typed, just enable auto-correct:
|
||||
|
||||
```bash
|
||||
$ git config --global help.autocorrect 1
|
||||
```
|
||||
|
||||
So now you will get this result:
|
||||
So now you will get this:
|
||||
|
||||
```bash
|
||||
$ git comit -m "Message"
|
||||
@@ -574,16 +595,11 @@ $ git comit -m "Message"
|
||||
# in 0.1 seconds automatically...
|
||||
```
|
||||
|
||||
### Color
|
||||
|
||||
To add more colour to your git command line:
|
||||
#### Color
|
||||
To add more color to your Git output:
|
||||
|
||||
```bash
|
||||
$ git config --global color.ui 1
|
||||
```
|
||||
|
||||
[*Read more about the Git `config` command.*](http://git-scm.com/docs/git-config)
|
||||
|
||||
# Sharing
|
||||
|
||||
Share on [Twitter](https://twitter.com/intent/tweet?source=webclient&text=http%3A%2F%2Fgithub.com%2Ftiimgreen%2Fgithub-cheat-sheet%20-%20GitHub%20Cheat%20Sheet)
|
||||
|
||||
Reference in New Issue
Block a user