Developer Crash Course

First, get familiar with Git, forks, and pull requests (PRs). Do you know the difference between Git and GitHub? If any of this is iffy for you, the following resources may help:

• https://help.github.com/articles/set-up-git/
• https://help.github.com/articles/working-with-forks/
• https://help.github.com/articles/about-pull-requests/

How to propose a change to the website

If you run into trouble with the following instructions, consult this very similar GitHub documentation.

1. Make a fork of the cubingusa/org repo if you have not already done so.
2. Install the appropriate version of Ruby. You can see which version of Ruby we use in our travis configuration.
3. gem install bundler - Install Bundler if you do not already have it.
4. bundle install - Install dependencies.
5. bundle exec jekyll serve - This will build the website and start a webserver, accessible at http://127.0.0.1:4000/.
6. Make changes! If you don't know anything about Jekyll, read up on its directory structure. The bundle exec jekyll serve command you ran in the previous step will automatically detect changes you make to files, but you will have to manually refresh your webbrowser to see the changes.

How to propose a change to the website

1. Create a PR with your changes from above. You should probably get someone to approve your changes before you proceed on to the next section.

Pro tip! Don't forget to run script/build.sh && script/test.sh to run our tests before you create your PR.

How to deploy a change

1. Merge your PR. Travis will take care of automatically building and deploying your changes to the gh-pages branch. Wait a few minutes, and see your changes live on https://cubingusa.github.io/org/! If something goes wrong, then something probably went wrong with our Travis build. Investigate here.