Archive for the ‘Getting Started’ Category

Here’s a simple rundown of some commands Tobi and I came up with in preparation for the sprint. You can use these to contribute to MarkUs. This post assumes you have already set up a github account and an ssh public key that you will be using later on.

Setting up MarkUs

Visit the upstream repo on github and select “Fork”. This will create a clone of the repository on your github account.

From your fork, copy the URL that allows you to access it using SSH.

Run the following command in terminal using the URL you just copied.$ git clone git@github.com:YOUR_GIT_USERNAME/Markus.git

Next, create a remote to the master repository of MarkUs upstream. This will be used to keep your local copy up to date.$ git remote add markus-upstream git://github.com/MarkUsProject/Markus.git

Make sure the remote was added.$ git remote -v
You should see “markus-upstream” and “origin”.
Note the remote origin, it should point to the SSH URL you cloned with. If this URL contains “https”, then you have not cloned using SSH. Run the following command to change it to the URL used when cloning (see above).$ git remote set-url origin git@github.com:YOUR_GIT_USERNAME/Markus.git

Simple Development

From the MarkUs root directory in a terminal, run the following commands:

Create a branch$ git branch issue-1234
$ git checkout issue-1234

Modify the files with the changes you want to implement. Let’s say I’ve modified Changelog and config.ru with the most amazing fix for issue 1234!

Before setting up a review request, make sure your issue and master branches are up to date (see below), making sure the changesets you just pulled in do not affect your code. Once they are, setup a review request.$ git push origin issue-1234
Go to your github fork and change to your issue branch. You should see the button “Pull Request” (right by the button to fork). In the write fill, fill it in with the issue number, quick summary of the issue, desciption of the fix and what testing was performed.