Difference between revisions of "Working with the development version"

From VDrift
Jump to: navigation, search
m (Getting the development version moved to Working with the development version: Focusing this article on the VDrift specific workflow. Moved content that is irrelevant to this to Getting VDrift.)
m (Updating: Spelling!)
Line 10: Line 10:
  
 
===Updating===
 
===Updating===
Once the reposotory has been checked out, it can be updated without downloading the entire thing again. For command line git, use the command
+
Once the repository has been checked out, it can be updated without downloading the entire thing again. For command line git, use the command
 
  git pull
 
  git pull
 
to check for updates and apply them.
 
to check for updates and apply them.

Revision as of 15:35, 8 February 2012

See this documentation for more info: http://help.github.com/

Making your own changes

If you want to make your own changes to improve VDrift, the easiest way is to fork the main VDrift repo on GitHub (https://github.com/VDrift/vdrift/). Just click the button near the top right of the page. You will need a free GitHub account. Then clone your new repo onto your computer:

git clone git@github.com:username/vdrift.git

And link this to the original VDrift repo:

git remote add upstream git://github.com/VDrift/vdrift.git
git fetch upstream

Updating

Once the repository has been checked out, it can be updated without downloading the entire thing again. For command line git, use the command

git pull

to check for updates and apply them. If you have made some changes, use the following instead to prevent these being lost:

git fetch upstream
git merge upstream/master

Uploading changes

To upload any changes you've made, first add the files to the commit:

git add filename

Then do the commit:

git commit -m 'Commit message'

And finally send this to GitHub:

git push origin master

Checking in changes

You can request a VDrift developer to incorporate your changes by initiating a GitHub pull request. See this documentation for more info: http://help.github.com/send-pull-requests/


Thank you for helping make VDrift better for everyone!