diff --git a/README.ko.md b/README.ko.md index 804f977..d9129e0 100644 --- a/README.ko.md +++ b/README.ko.md @@ -1,12 +1,13 @@ -# GitHub Cheat Sheet +# 깃허브 치트 시트 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) @@ -19,6 +20,7 @@ All the hidden and not hidden features of Git and GitHub. This cheat sheet was i - [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) - [Emojis](#emojis) - [Images/GIFs](#imagesgifs) - [Quick Quoting](#quick-quoting) @@ -27,7 +29,8 @@ All the hidden and not hidden features of Git and GitHub. This cheat sheet was i - [Git Query](#git-query) - [Merged Branches](#merged-branches) - [Quick Licensing](#quick-licensing) -- [TODO Lists](#todo-lists) +- [Task Lists](#task-lists) +- [Relative Links](#relative-links) - [.gitconfig Recommendations](#gitconfig-recommendations) - [Aliases](#aliases) - [Auto-correct](#auto-correct) @@ -37,6 +40,8 @@ All the hidden and not hidden features of Git and GitHub. This cheat sheet was i `?w=1`를 diff URL에 추가하면 변경된 코드만 볼 수 있도록, 공백만 바뀐 수정을 제거할 수 있습니다. +[*깃허브의 비밀을 더 읽어 보세요.*](https://github.com/blog/967-github-secrets) + ## Cloning a Repo 저장소를 클론할 때, 맨 뒤의 `.git`은 생략할 수 있습니다. @@ -45,6 +50,8 @@ All the hidden and not hidden features of Git and GitHub. This cheat sheet was i $ git clone https://github.com/tiimgreen/github-cheat-sheet ``` +[*깃 `clone` 커맨드에 대해 더 읽어 보세요.*](http://git-scm.com/docs/git-clone) + ## Hub - Git Wrapper [Hub](https://github.com/github/hub)는 깃허브를 좀 더 쉽게 사용할 수 있도록 추가 기능 및 명령을 제공하는 커맨드 라인 깃 래퍼입니다. @@ -61,6 +68,16 @@ $ git clone https://github.com/tiimgreen/toc.git $ hub clone tiimgreen/toc ``` +[*Hub가 제공하는 더 멋진 기능들을 확인해 보세요.*](https://github.com/github/hub#commands) + +## Decreasing Contributor Friction + +사람들이 사용하고 기여할 수 있는 프로젝트를 만드려면, 가장 기본적인 질문에 대답할 수 있어야합니다. 이 프로젝트는 무엇입니까? 어떻게 사용합니까? 어디까지 허용됩니까? 어떻게 기여합니까? 어떻게 개발하고 실행해야 합니까? 어떻게 새로운 기능이 이전 기능을 손상되지 않았는지 확인해야 합니까? + +[Friction](https://github.com/rafalchmiel/friction)은 이러한 일반적인 질문들의 답이 프로젝트 안에 있는지 확인하는 커맨드 라인 스크립트 입니다. 다음은 샘플 출력 입니다. + +[![Friction output](http://i.imgur.com/4EgpWo4.png)](https://github.com/rafalchmiel/friction) + ## Previous Branch 커맨드 라인에서 이전 디렉터리로 이동하려면 이렇게 합니다. @@ -82,12 +99,16 @@ $ git checkout - # Switched to branch 'master' ``` +[*깃 브랜치에 대해 더 읽어 보세요.*](http://git-scm.com/book/en/Git-Branching-Basic-Branching-and-Merging) + ## git.io [git.io](http://git.io)는 깃허브를 위한 간단한 URL 단축기입니다. [http://git.io/wO0xUg](http://git.io/wO0xUg) +[*Git.io에 대해 더 읽어 보세요.*](https://github.com/blog/985-git-io-github-url-shortener) + ## Gists [Gists](https://gist.github.com/)는 본격적인 저장소를 만들지 않고, 작은 코드 조각과 일할 수 있는 쉬운 방법입니다. @@ -100,6 +121,8 @@ $ git clone https://gist.github.com/tiimgreen/10545817 ![Gists](http://i.imgur.com/dULZXXo.png) +[*gist를 만드는 법에 대해 더 읽어보세요.*](https://help.github.com/articles/creating-gists) + ## Keyboard Shortcuts 저장소 페이지에서 단축키를 사용하면 쉽게 이동할 수 있습니다. @@ -110,13 +133,17 @@ $ git clone https://gist.github.com/tiimgreen/10545817 `s`를 누르면 검색 창으로 이동합니다. +`l`를 누르면 있는 이슈의 라벨을 수정할 수 있습니다. + __파일을 보고 있을 때__ (예를 들어 `https://github.com/tiimgreen/github-cheat-sheet/blob/master/README.md`) `y`를 누르면 URL을 지금 보고 있는 페이지를 사실상 고정하도록 합니다. 코드가 바뀐다고 해도 이번에 본 내용을 다시 볼 수 있습니다. 지금 페이지에서 쓸 수 있는 모든 단축키를 보시려면 `?`를 누르세요. +[*커맨드 바의 사용법을 더 읽어 보세요.*](https://help.github.com/articles/using-the-command-bar) + ## Closing Issues with Commits -어떤 커밋이 이슈를 고쳤다면, `fix/fixes/fixed`나 `close/closes/closed`를 키워드로 해당 이슈를 닫을 수 있습니다. +어떤 커밋이 이슈를 고쳤다면, `fix/fixes/fixed`나 `close/closes/closed`를 키워드로 해당 이슈가 마스터 브랜치에 커밋 될 때 닫을 수 있습니다. ```bash $ git commit -m "Fix cock up, fixes #12" @@ -126,6 +153,8 @@ $ git commit -m "Fix cock up, fixes #12" ![Closing Repo](http://i.imgur.com/URXFprQ.png) +[*커밋 메세지로 이슈 닫기에 대해 더 읽어 보세요.*](https://help.github.com/articles/closing-issues-via-commit-messages) + ## Checking out Pull Requests 풀 리퀘스트를 체크아웃하려면, 다음 명령어로 가져올 수 있습니다. @@ -167,6 +196,8 @@ $ git checkout origin/pr/42 fetch = +refs/pull/*/head:refs/remotes/origin/pr/* ``` +[*풀 리퀘스트를 로컬로 체크아웃 하는 방법에 대해 더 읽어 보세요.*](https://help.github.com/articles/checking-out-pull-requests-locally) + ## Cross-link Issues 같은 저장소의 다른 이슈를 링크하기 원한다면, `#`뒤에 이슈 번호만 입력하시면 자동으로 링크됩니다. @@ -195,6 +226,8 @@ puts table.to_s 깃허브는 [Linguist](https://github.com/github/linguist)를 사용해 언어를 감지하고 신텍스를 하이라이트합니다. [언어 YAML 파일](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml)을 정독하시면 어떤 키워드가 유효한지 확인하실 수 있습니다. +[*깃허브 Flavored 마크다운에 대해 더 읽어 보세요.*](https://help.github.com/articles/github-flavored-markdown) + ## Commit History by Author 특정 커미터가 한 모든 커밋을 보고 싶다면 URL에 `?author=username`를 추가하세요. @@ -203,6 +236,8 @@ puts table.to_s https://github.com/rails/rails/commits/master?author=dhh ``` +[*커밋 뷰간의 차이에 대해 더 읽어보세요.*](https://help.github.com/articles/differences-between-commit-views) + ## Empty Commits `--allow-empty`를 추가하시면 코드의 변경 없이 커밋을 넣을 수 있습니다. @@ -237,6 +272,22 @@ https://github.com/rails/rails/compare/master@{2014-10-04}...master 이렇게 하면 특정 날짜나 한 시간 전의 마스터 브랜치의 차이를 확인할 수 있습니다. +[*시간으로 커밋을 비교하는 법에 대해 더 읽어 보세요.*](https://help.github.com/articles/comparing-commits-across-time) + +### Compare branches across forked repositories + +포크된 저장소간의 브랜치를 비교하려면 URL을 이렇게 변경하세요. + +``` +https://github.com/user/repo/compare/{foreign-user}:{branch}...{own-branch} +``` + +예를 들면 + +``` +https://github.com/rails/rails/compare/byroot:idempotent-counter-caches...master +``` + ## Line Highlighting in Repos 코드 파일 URL의 끝에 `#L52`를 추가하거나 줄 번호를 클릭하면 그 줄 번호를 하이라이트합니다. @@ -249,6 +300,14 @@ https://github.com/rails/rails/blob/master/activemodel/lib/active_model.rb#L53-L ![Line Highlighting](http://i.imgur.com/8AhjrCz.png) +## Metadata and Plugin Support for GitHub Pages + +지킬로 작성된 페이지와 포스트에서, 저장소 정보는 예를 들어 `{{ site.github.project_title }}`처럼 `site.github` 이름 공간으로 사용하고 표시할 수 있습니다. + +Jemoji와 jekyll-mentions플러그인은 GitHub.com에서 처럼 [emoji](#emojis)와 [@mentions](https://github.com/blog/821)을 지킬 포스트와 페이지에서 사용하게 합니다. + +[*저장소 메타 데이타와 깃허브 페이지의 플러그인 지원에 대해 더 읽어 보세요.*](Repository metadata and plugin support for GitHub Pages) + ## Emojis 에모지는 풀 리퀘스트, 이슈, 커밋 메세지, README등등에서 `:에모지의_이름:`으로 만들 수 있습니다. @@ -283,7 +342,7 @@ https://github.com/rails/rails/blob/master/activemodel/lib/active_model.rb#L53-L ![Alt Text](http://image_url.com/image.jpg) ``` -![Chuck Norris](http://gifs.joelglovier.com/chuck-norris/chuck-norris.gif) +![Cat and Rabbit](http://i.imgur.com/PoBmL0W.gif) 모든 이미지는 GitHub에서 케쉬합니다. 그래서 호스트가 죽어도 이미지는 여전히 남습니다. @@ -291,7 +350,9 @@ https://github.com/rails/rails/blob/master/activemodel/lib/active_model.rb#L53-L 스레드에 답글들 때 전에 누가 말한 어떤 내용을 인용하고 싶다면, 텍스트를 하이라이트하고 `r`을 누르세요. 이렇게 하면 내용을 텍스트 박스에 인용 포맷으로 복사해 줍니다. -![Quick Quote](http://i.imgur.com/TzpMIOA.png) +![Quick Quote](https://f.cloud.github.com/assets/296432/124483/b0fa6204-6ef0-11e2-83c3-256c37fa7abc.gif) + +[*빠른 인용에 대해 더 읽어 보세요.*](https://github.com/blog/1399-quick-quotes) ## Styled Git Status @@ -309,6 +370,8 @@ $ git status -sb ![git status -sb](http://i.imgur.com/xNI1bT0.png) +[*깃 `status` 커맨드에 대해 더 읽어 보세요.*](http://git-scm.com/docs/git-status) + ## Styled Git Log ```bash @@ -319,6 +382,8 @@ $ git log --all --graph --decorate --oneline --abbrev-commit NOTE: 이 명령을 알리아스 (단축 명령)으로 넣을 수 있습니다. [여기](#aliases)의 소개를 보세요. +[*깃 `log` 커맨드에 대해 더 읽어 보세요.*](http://git-scm.com/docs/git-log) + ## Git Query 깃 쿼리는 모든 이전 커밋 메시지에서 검색해 가장 최근의 쿼리에 맞는 커밋을 찾아줍니다. @@ -332,7 +397,8 @@ $ git show :/query ```bash $ git show :/typo ``` -![git show :/query](http://i.imgur.com/SA0oZbE.png) + +![git show :/query](http://i.imgur.com/icaGiNt.png) NOTE: 나오려면 `q`를 누르세요. @@ -352,6 +418,8 @@ $ git branch --no-merged 이 명령어는 현재 브랜치에 머지되지 않은 브랜치의 목록을 보여줍니다. +[*깃 `branch` 커맨드에 대해 더 읽어 보세요.*](http://git-scm.com/docs/git-branch) + ## Quick Licensing 저장소를 만들 때, 깃허브는 만들어진 저작권을 추가할 수 있는 옵션을 제공합니다. @@ -365,7 +433,9 @@ $ git branch --no-merged `.gitignore`에도 똑같이 적용됩니다. -## TODO Lists +[*오픈 소스 저작권에 대해 더 읽어 보세요.*](https://help.github.com/articles/open-source-licensing) + +## Task Lists 이슈와 풀 리퀘스트에서 밑의 문법으로 체크박스를 넣을 수 있습니다.(스페이스에 주의하세요.) @@ -375,7 +445,7 @@ $ git branch --no-merged - [ ] Sleep ``` -![TODO List](http://i.imgur.com/k2qZi56.png) +![Task List](http://i.imgur.com/k2qZi56.png) 체크박스가 클릭 되면, 순수 마크다운에서 갱신이 이루어집니다. @@ -385,6 +455,23 @@ $ git branch --no-merged - [ ] Sleep ``` +[*테스크 리스트에 대해 더 읽어 보세요.*](https://github.com/blog/1375%0A-task-lists-in-gfm-issues-pulls-comments) + +## Relative Links + +상대 경로 링크는 마크다운 파일이 내부 건탠츠로 링크될 때 추천합니다. + +```markdown +[Link to a header](#awesome-section) + +[Link to a file](docs/readme) +``` + +절대 경로 링크는 URL이 변경 될 때 마다 변경해야 합니다. (예를 들어 저장소 이름 변경, 유저이름 변경, 프로젝트 포크) +상대 경로 링크를 사용하면 문서를 쉽게 스스로 독립적으로 만들 수 있습니다. + +[*상대 경로 링크에 대해 더 읽어 보세요.*](https://help.github.com/articles/relative-links-in-readmes) + ## .gitconfig Recommendations `.gitconfig`는 모든 설정이 들어있는 파일입니다. @@ -400,6 +487,10 @@ $ git branch --no-merged co = checkout cm = commit p = push + # Show verbose output about tags, branches or remotes + tags = tag -l + branches = branch -a + remotes = remote -v ``` 커맨드 라인에서 다음 명령을 입력합니다. @@ -428,6 +519,9 @@ $ git config alias.ac 'add -A . && commit' | `git co` | `git checkout` | `git config --global alias.co checkout` | | `git ac` | `git add . -A` `git commit` | `git config --global alias.ac '!git add -A && git commit'` | | `git st` | `git status -sb` | `git config --global alias.st 'status -sb'` | +| `git tags` | `git tag -l` | `git config --global alias.tags 'tag -l'` | +| `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 @@ -464,6 +558,8 @@ $ git comit -m "Message" $ git config --global color.ui 1 ``` +[*깃 `config` 커맨드에 대해 더 읽어 보세요.*](http://git-scm.com/docs/git-config) + # Sharing -[트위터](https://twitter.com/intent/tweet?source=webclient&text=http%3A%2F%2Fgit.io%2FvvT17g%20-%20GitHub%20치트%20시트)에 공유하기 +[트위터](https://twitter.com/intent/tweet?source=webclient&text=http%3A%2F%2Fgit.io%2FvvT17g%20-%20깃허브%20치트%20시트)에 공유하기