Skip to content

Latest commit

 

History

History
64 lines (49 loc) · 3.19 KB

CONTRIBUTING.md

File metadata and controls

64 lines (49 loc) · 3.19 KB
Raw

We are a group of people excited about data literacy and/or R. We want to teach journalists how to use R for their work.

Want to help?

Awesome! We need lots of help! We are very thankful for any contribution. You don't need to be an R specialist or know R at all. Come talk to us to find out how you could possibly help 🍰 😃 👏

Send an email to [email protected] (Heidi is very friendly and will help you figure out how you can best contribute to the project) or join our gitter chat.

We currently need help with:

  • Creating tutorials (data recipes and skills lessons)
  • Translation (no R knowledge required)
  • Beta testing (see below): go through the existing material and point out things you don't understand or points where you get stuck.
  • Planning of the website

Creating tutorials

If you want to add a data recipe or skills lesson, please use the templates to get started:

You can look at the end-result in R via:

devtools::install_github("school-of-data/r-consortium-proposal", 
                         subdir="r-package")
learnr::run_tutorial("en-recipe-template", package = "ddj")
learnr::run_tutorial("en-skills-template", package = "ddj")

Process of creating a data recipe

  1. Find an interesting story for journalists based on a dataset. Note: The dataset should be publicly available data. Datasets containing personal information will not be accepted.
  2. Clone to the repo or simply copy the Rmarkdown file
  3. Following the data pipeline described in the template, create your recipe with: one section of your recipe = one section of the data pipeline. Note: the recipe should be self-contained: readers should not have to look up external material to complete it.
  4. Create a pull request on Github in order for your recipe to be reviewed and added to the list. Alternatively, send an email to heidi [at] schoolofdata [dot] ch

Beta testing

You have R and RStudio installed and know how to run R code and install packages? You speak English? Then you are the right person to help us in beta testing! 🙌

  1. Find content you'd like to test. Currently the Introduction and the Swiss dual use data recipe are ready for beta testing. To take a look at them, open R and run:
devtools::install_github("school-of-data/r-consortium-proposal", 
                         subdir="r-package")

and then

learnr::run_tutorial("en-introduction", package = "ddj")

for looking at the Introduction or

learnr::run_tutorial("en-recipe-switzerland-dual-use", package = "ddj")

for the Swiss dual use data recipe.

  1. Open an issue and fill it out. You don't have to do it all at once. Do it in your pace and come back when you have time! The template shows you how to give us a sign that you are done. Do that in the end.

  2. Be proud of yourself 🍰 👏 😄