Skip to content

Commit

Permalink
update wording
Browse files Browse the repository at this point in the history
  • Loading branch information
ThierryO committed Mar 8, 2023
1 parent 22a4f38 commit 60f3b39
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 6 deletions.
2 changes: 1 addition & 1 deletion R/check_folder.R
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
#' Simple projects in which `source` has no subfolders, place `data` at the
#' root of the project.
#' For more elaborate project you must choose between either `data` at the root
#' of the project or `data` as sub folder of the sub folders of `source`.
#' of the project or `data` as subfolder of the subfolders of `source`.
#' E.g. `source/report/data`.
#'
#' Place the data in an open file format.
Expand Down
4 changes: 2 additions & 2 deletions man/check_folder.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions vignettes/folder.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ The `media` folder holds the images you want to incorporate in the Rmarkdown fil
The `inst` folder stores some `checklist` specific data.

While you can add other folders the root of your `checklist` project, we recommend to stick with the default folders.
Having a non standard folder name results in a warning when running `check_folder()`.
Having a non-standard folder name results in a warning when running `check_folder()`.

In case you want to use version control (strongly recommended), use the root of the R project as the root of the version control project.

```
─┬─ main_folder
├─── folder_a
├─── folder_b
└─┬─ r_project_name
└─┬─ checklist_project_name
├─── data
├─── inst
├─── media
Expand Down
4 changes: 3 additions & 1 deletion vignettes/getting_started_project.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -84,5 +84,7 @@ In case of a previous set-up, it will take that into account.
- Add branch protection rule
- branch name pattern: `main`
- activate "Require a pull request before merging"
- in case a team works on the project consider to activate "Require approvals"
- activate "Require status checks to pass before merging"
-
- search and select "check project with checklist"
- activate Require "branches to be up to date before merging"

0 comments on commit 60f3b39

Please sign in to comment.