Skip to content
This repository was archived by the owner on Aug 25, 2019. It is now read-only.

Latest commit

 

History

History
48 lines (38 loc) · 3 KB

README.md

File metadata and controls

48 lines (38 loc) · 3 KB

DARIAH-CAMPUS PILOT

This is the pilot version of DARAIAH-CAMPUS which was based on Jekyll. It is no longer under development. We have since moved to MDX and Gatsby. The new repo is https://github.com/DARIAH-ERIC/dariah-campus/.

GitHub Workflow

Setting up DARIAH-CAMPUS on your computer

  1. Install GitHub Desktop on your computer
  2. Open GitHub Desktop
  3. Sign in with your GitHub credentials
  4. Go to https://github.com/DARIAH-ERIC/dariah-campus
  5. Click on "Clone or download" then select "Open in Desktop"
  6. In GitHub Desktop choose where you want to save the dariah-campus clone on your computer

Contributing to DARIAH-CAMPUS

First-time contribution

  1. In GitHub Desktop, create a new branch off of master.
    Call it by your name, then go watch the movie "Call me by your name" if you haven't seen it already.
  2. Do your work.
  3. Commit your work.
    This will save your initial work to your branch locally.
  4. Publish your branch. This will save your intial work to your branch remotely.
  5. Create a pull request.
    This will alert the repository admin person that there are changes that should be merged into the master branch, i.e. made public.

Subsequent contributions

Before you make your next contribution, you have to make sure that your local branch is up to date. Remember, you created your special little branch off of the master at some point, but other people may have contributed to the master in the meantime. So it's very important that you follow this procedure every time you start doing work on your branch again.

  1. In GitHub Desktop, in your branch, fetch origin.
    This will check whether there were any changes made to your branch remotely.
  2. If GitHub Desktop instructs you to pull origin, pull origin.
    This will make sure that your local and your remote branch are in sync. Which is important, if you have, for instance, used a different computer to commit and publish etc. Or if, God forbid, somebody messed around with your branch. They shouldn't. But it did happen at least once. And Toma was to blame :)
  3. Branch > Update from master
    This will now, in addition, update your local branch with all the contributions that have meanwhile been merged into the master from the other branches. Remember, each contributor works in their own branch.
  4. If GitHub Desktop instructs you to push origin, push origin.
    This will make sure that the changes from the master branch, which you've added to your local branch in the previous step, will also make it to your remote branch. With your local and remote branch fully updated and sync you can finally get to do your work.
  5. Do your work.
  6. Commit your work.
    This will save your work to your branch locally.
  7. Push origin.
    This will save your work to your branch remotely.
  8. Create a pull request.
    This will alert the repository admin person that there are changes that should be merged into the master branch, i.e. made public.