Collaborator guide

If you are a collaborator in this github project, you can follow these instructions.

SVN-like simple workflow (to get started)

Note: this workflow ignores many potentially good features of git, but it should be easy to grasp and keep on working as with svn

Generate public key and add it to your github account settings.
(instructions for mac: http://help.github.com/mac-key-setup/)

get the repository to your local machine
git clone [email protected]:sizzlelab/asi.git
(does similar as svn checkout)

update your local repository from the origin repo (do this often)
git pull
(does similar as svn update)

make changes to code as normal

svn status = git status
svn commit -m “commit message” = git commit -a -m “commit message” (this commits to your local repo only and adds all modified file to the commit)
to actually put your commits to the original github repo use: git push

With git it is good idea to use branches. You can also push your branches to the origin at github if you wish.

More detailed instructions about git can be found for example at: Git_Guide

Running unit tests

To run unit tests you need to make sure that your sphinx daemon is running in the rails test environment, i.e.

rake thinking_sphinx:rebuild RAILS_ENV=test

The above command will fail if you already have a sphinx daemon running at the designated port, so you will need to stop the other daemon and then restart it in test environment.

After doing that you should get no errors or failures when running:

rake test:units