Contributing
Please see GitHub’s Help on
Fork
ing if this is unfamiliar terminology
For this collection of examples, assume that administrators Joanna
and Elizabeth
have the following configuration blocks within their local ~/.ssh/config
files…
Elizabeth
‘s ~/.ssh/config
file
Host github.com
IdentitiesOnly yes
IdentityFile ~/.ssh/github_private.key
HostName github.com
User git
Host server_admin
IdentitiesOnly yes
IdentityFile ~/.ssh/private.key
HostName <ip-to-server>
User root
Host liz
IdentitiesOnly yes
IdentityFile ~/.ssh/private.key
HostName <ip-to-server>
User liz
Host git_liz
IdentitiesOnly yes
IdentityFile ~/.ssh/private.key
HostName <ip-to-server>
User Elizabeth
Joanna
‘s ~/.ssh/config
file
Host github.com
IdentitiesOnly yes
IdentityFile ~/.ssh/github_private.key
HostName github.com
User git
Host joan
IdentitiesOnly yes
IdentityFile ~/.ssh/private.key
HostName <ip-to-server>
User joan
Host git_joan
IdentitiesOnly yes
IdentityFile ~/.ssh/private.key
HostName <ip-to-server>
User Joanna
… where <ip-to-server>
is replaced with the IP address to the server that they are administrating.
Note,
<GitHub-UserName>
in either of the following should be replaced by a GitHub User Name controlled by the respective life-form.
For the sake of an example, suppose that Elizabeth
has already clone
d this project’s source code prior fork
ing, adding a new remote might look something like…
cd ~/github/Jekyll_Admin
git remote add fork https://github.com/<GitHub-UserName>/Jekyll_Admin.git
… now things like git push fork master
will mean something to Git
And to continue the example suppose Joanna
has already fork
ed and cloned from there, eg…
cd ~/github
git clone git@github.com:<GitHub-UserName>/Jekyll_Admin.git
… then adding an upstream
remote for tracking this project’s source during tests may look like…
cd ~/github/Jekyll_Admin
git remote add upstream https://github.com/S0AndS0/Jekyll_Admin.git
… which enables merging
ing from this project’s source via…
git fetch upstream gh-pages:src_gh-pages
git checkout gh-pages
git merge src_gh-pages
Advanced Setup Examples
-
Master Branch Development Installation
Utilize
git remote add
withroot
level access to remote server to ensure testing environment and usage is similar documented examples -
GitHub Pages Branch Development Installation
Utilizing this project’s scripts to test and develop documentation for this project
-
Git Shell Commands Development
Quick how-to submit patches to the git-shell-commands scripts
-
Merge Development Branch
Tips for a happy
squash
edgit merge
oflocal_
branches -
Pull Request
Tips for issuing Pull Requests