TakeV/spacemacs
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/contrib/!source-control/github/README.org
Robert O'Connor 987d731916 Add documentation for '# g c' to the github layer 
Update the README to include documentation for '# g c'
which  allows people to create PRs from emacs and then opens
it in the browser.
2015-08-10 22:47:30 -04:00

3.8 KiB
Raw Blame History

Github contribution layer for Spacemacs

/TakeV/spacemacs/media/commit/8244eb9adb42c4115ea0ee39e83bc4f4b0df887f/contrib/!source-control/github/img/github.png

Table of Contents   TOC@4

Description

This layers adds support for Github.

Features:

Install

Layer

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

(setq-default dotspacemacs-configuration-layers '(github))

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.