Github guide

Gitbub is a online hosting service for software development projects using the Git revision control and source code management system.

Transfer protocol

This guide covers basic Git commands to work with Redaxscript and Github. Read the official and comprehensive Git documentation: git-scm.com/doc for detailed information and more examples.

Install Git

Install Git on your favorite operation system: git-scm.com/downloads

Checkout repository

Login to Github and fork the Redaxscript repository: github.com/redaxmedia/redaxscript/fork
Browse your working directory and checkout your Redaxscript repository using git clone from console.

git clone https://github.com/{your-github-user}/redaxscript.git

Enter your user and password to authenticate your Github identity.

Config Git

Browse your working copy of Redaxscript and config your user information using git config from console.

git config user.name {your name}
git config user.email {user@domain.com}

Keep in mind that your user information will be displayed on each commit.

Contribute code

Make changes to your working copy of Redaxscript. Check your local changes using git status from console.

git status

Add files and commit your changes using git commit from console.

git commit -a -m {your commit message}

Push your changes to your remote repository using git push from console.

git push

Send a pull request on Github - your changes will be reviewed and possibly merged to the original Redaxscript repository.

Syncronize repository

Add the original Redaxscript repository using git remote add from console.

git remote add upstream git://github.com/redaxmedia/redaxscript.git

Check existing remote repositories using git remote from console.

git remote

Fetch changes from remote repository and merge with your working copy using git pull from console.

git pull upstream master

Push your changes to your remote repository using git push from console.

git push

Enter your user and password to authenticate your Github identity.

Grunt shortcut

There is an shortcut using the grunt sync task from console.

grunt sync
Powered by Redaxscript 2.1.0  •  Design and realization by Jörg Steinhauer & Henry Ruhs