Skip to content
This repository has been archived by the owner on Jul 27, 2019. It is now read-only.

Home

Jump to bottom
mhBrice edited this page Dec 21, 2018 · 5 revisions

Welcome to the QCBS R Workshops wiki!

In this section, we explain how you can contribute to the QCBS R workshops.

Getting started

Install package and clone repo

This Rmarkdown presentations are created using xaringan, so the first step in to install the R package xaringan.

if(!require(devtools)) install.packages('devtools')
devtools::install_github('yihui/xaringan')

Secondly, you need to create a local copy on your computer of the Workshops repository. To do so, you can clone the GitHub repository on your computer using the command line:

git clone https://github.com/QCBSRworkshops/Workshops.git

Workflow

  1. Once you cloned the Workshops repository, you should be on the dev branch.

  2. Create a new branch (choose a name that reflects what you are adding, we suggest something explicit like workshop3_intro if you want to edit the introduction of workshop 3): git branch workshop3_intro.

  3. Switch branch: git checkout workshop3_intro; Note that you can create and switch branch with a single line of command: git checkout -b workshop3_intro.

  4. Do your changes!

  5. Once you are done with your changes on your branch, add and commit : git add -A and git commit -m "instructive message about what you did".

  6. Go back on the dev branch: git checkout dev and pull git pull just to make sure you are up to date.

  7. Switch back to your branch: git checkout workshop3_intro and merge locally: git merge dev. If there are conflicts, please resolve them! When you're done, push your branch on the Github repository: git push --set-upstream origin workshop3_intro.

  8. Open a Pull Request (PR).

  9. Assign your PR to a reviewer (one of the 3 R workshop coordinators).

  10. The reviewer will squash and merge the post once the build passed on Travis.

  11. Once the PR is merged, do not forget to pull the dev branch!

Other ways to help us!

If you are not confortable with GitHub, you can still help us improve the workshops!

If you notice any mistakes or inconsistencies, or if you'd like to make a suggestion, either in form or in content, you're invited to open an Issue. You can follow these simple steps to create a new Issue.

To modify the template

The template files (names that start with qcbsR...) and assets folder that are used to build the final presentations are in the repo templateWorkshops; the version in the workshop folder are only used locally. This means that local modification to the template files will not be used once you pushed. To modify the template, you need to modify from the templateWorkshops, then you can use the command line : make copy_css to copy the template files in all the workshop folders.

Clone this wiki locally