1- # Want to contribute? Great! : tada : {#contributing}
1+ # Want to contribute? Great! {#contributing}
22
33There are a few ways in which you can contribute:
44
5- - Participating in the discussions on issues.
6- - Adding to lesson material.
7- - Instructing a lesson or helping out.
5+ - Participating in the discussions on issues.
6+ - Adding to lesson material.
7+ - Instructing a lesson or helping out.
88
99## Participating in issue discussions :thought_balloon : :question :
1010
@@ -20,19 +20,19 @@ The lesson material and website are created using
2020documents and converts the source material into a static website. A few
2121things to consider when contributing to the lesson material:
2222
23- 1 . All lesson material that contains R code chunks needs to be in R
23+ 1 . All lesson material that contains R code chunks needs to be in R
2424 Markdown (` .Rmd ` ) or Quarto (` .qmd ` ) format.
25- 2 . Every lesson "chapter" starts with and has only one first level
25+ 2 . Every lesson "chapter" starts with and has only one first level
2626 "header" (` # ` ).
27- 3 . Lessons include a mix of code chunks and text, organized using
27+ 3 . Lessons include a mix of code chunks and text, organized using
2828 Markdown headers.
29- 4 . Participants should be able to follow the content of the lesson from
29+ 4 . Participants should be able to follow the content of the lesson from
3030 the text alone; i.e. the file should contain * all* conceptual
3131 explanations.
32- 5 . We teach the [ * tidyverse* ] ( https://www.tidyverse.org/ ) * way of using
32+ 5 . We teach the [ * tidyverse* ] ( https://www.tidyverse.org/ ) * way of using
3333 R* , meaning we use packages like dplyr, tidyr, rmarkdown, ggplot2,
3434 and so on. This also means making use of the pipe ` %>% ` operator.
35- 6 . We follow the tidyverse [ * way of writing and styling R
35+ 6 . We follow the tidyverse [ * way of writing and styling R
3636 code* ] ( https://style.tidyverse.org/ ) .
3737
3838Anyone can contribute to the workshop repository through GitHub by
@@ -46,23 +46,23 @@ but the preferred way). If you go the clone route, please use [the
4646GitHub flow style] ( https://guides.github.com/introduction/flow/ ) to
4747manage changes. Here are some steps to follow:
4848
49- 1 . [ Clone] ( https://help.github.com/articles/cloning-a-repository/ ) the
49+ 1 . [ Clone] ( https://help.github.com/articles/cloning-a-repository/ ) the
5050 repository to your local computer.
51- 2 . In your local copy of this repository, create a new
51+ 2 . In your local copy of this repository, create a new
5252 [ branch] ( https://help.github.com/articles/about-branches/ ) that will
5353 address one or two Issues.
54- 3 . Make edits to files and content that is specific to only a few
54+ 3 . Make edits to files and content that is specific to only a few
5555 Issues. Smaller changes made as a Pull Request are easier to review
5656 and merge than bigger changes. The more targeted and specific the
5757 changes are, the better.
58- 4 . As you make edits, commit your changes to that branch.
59- 5 . Push the edits on that branch to the workshop repository. Note that
58+ 4 . As you make edits, commit your changes to that branch.
59+ 5 . Push the edits on that branch to the workshop repository. Note that
6060 this assumes you have been added to the repository as a contributor.
6161 Otherwise, you'll need to make a
6262 [ fork] ( https://docs.github.com/en/get-started/quickstart/fork-a-repo )
6363 of the repository first.
64- 6 . Submit a merge/pull request of the branch into the main branch.
65- 7 . If you receive feedback on your pull request, make further commits
64+ 6 . Submit a merge/pull request of the branch into the main branch.
65+ 7 . If you receive feedback on your pull request, make further commits
6666 to the branch on your cloned local copy. These will automatically be
6767 added to your merge request after you commit and push.
6868
@@ -78,15 +78,15 @@ Making videos (on Linux) is done using
78781280x720), [ OpenShot] ( https://www.openshot.org/ ) (to edit the video if
7979necessary), and the below command to reduce the video file size:
8080
81- ```
81+ ```
8282ffmpeg -i input.mp4 -crf 28 output.mp4
8383```
8484
8585### (Re-)Building the website
8686
8787In order to build the website, you need to have the dependent packages
88- installed. Packages used and depended on for this workshop are included in
89- the ` DESCRIPTION ` file. To install the packages, run this function in
88+ installed. Packages used and depended on for this workshop are included
89+ in the ` DESCRIPTION ` file. To install the packages, run this function in
9090the root directory (where the ` .Rproj ` file is located):
9191
9292``` r
0 commit comments