spacemacs/contrib/!source-control/github/README.org

#+TITLE: Github contribution layer for Spacemacs

[[file:img/github.png]]

* Table of Contents                                                   :TOC@4:
 - [[#description][Description]]
     - [[#features][Features:]]
 - [[#install][Install]]
     - [[#layer][Layer]]
 - [[#key-bindings][Key Bindings]]
     - [[#magit-gh-pulls][magit-gh-pulls]]
     - [[#gistel][gist.el]]
     - [[#browse-files][Browse files]]

* Description

This layers adds support for [[http://github.com][Github]].

** Features:
- [[https://github.com/sigma/magit-gh-pulls][magit-gh-pulls]]: handy =magit= add-on to manage Github pull requests.
- [[https://github.com/defunkt/gist.el][gist.el]]: full-featured mode to browse and post Github gists.
- [[https://github.com/osener/github-browse-file][github-browse-file]] and [[https://github.com/sshaw/git-link][git-link]]: quickly browse github URL in your
  browser.

* Install

** Layer

To use this contribution add it to your =~/.spacemacs=

#+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers '(github))
#+END_SRC

* Key Bindings

** magit-gh-pulls

In a =magit status= buffer (~SPC g s~):

| Key Binding | Description                                     |
|-------------+-------------------------------------------------|
| ~# g c~     | create a pull request                           |
| ~# g g~     | get a list of all PRs in the current repository |
| ~# g f~     | fetch the commits associated to the current PR  |
| ~# g b~     | create a branch for the current PR              |
| ~# g m~     | merge the PR with current branch                |

Note that =magit-gh-pulls= will try to fast-forward the PRs whenever it is
possible.

** gist.el

| Key Binding | Description                                   |
|-------------+-----------------------------------------------|
| ~SPC g g b~ | create a public gist with the buffer content  |
| ~SPC g g B~ | create a private gist with the buffer content |
| ~SPC g g l~ | open the gist list buffer                     |
| ~SPC g g r~ | create a public gist with the region content  |
| ~SPC g g R~ | create a private gist with the region content |

In the gist list buffer:

| Key Binding | Description                  |
|-------------+------------------------------|
| ~/~         | evil search                  |
| ~+~         | add buffer to gist           |
| ~-~         | remove file for gist         |
| ~b~ or ~o~  | open current gist in browser |
| ~f~         | fetch current gist           |
| ~g~         | refresh the list             |
| ~h~         | go left                      |
| ~j~         | go down                      |
| ~k~         | go up                        |
| ~K~         | kill current gist            |
| ~l~         | go right                     |
| ~n~         | next search occurrence       |
| ~N~         | next previous occurrence     |
| ~v~         | =visual state=               |
| ~V~         | =visual-line state=          |
| ~y~         | print URL and copy it        |

** Browse files

| Key Binding | Description                                                        |
|-------------+--------------------------------------------------------------------|
| ~SPC g f b~ | browse to file on github                                           |
| ~SPC g f c~ | browse to file on github/bitbucket/etc (on current line at commit) |
| ~SPC g f C~ | only copy the generated link on the kill ring                      |
| ~SPC g f l~ | browse to file on github/bitbucket/etc (on current line position)  |
| ~SPC g f L~ | only copy the generated link on the kill ring                      |

*Notes:*
- You can use the universal argument ~SPC u~ to select a remote repository.
- You can use =git-link= on a region.
- When the link is opened, the URL is also copied in the kill ring, you can
  override this behavior by setting the variable =git-link-open-in-browser= to
  =nil=.