Skip to content

Commit 17adcda

Browse files
committed
update_pr_template: refresh pr template
1 parent c08b74d commit 17adcda

1 file changed

Lines changed: 15 additions & 5 deletions

File tree

.github/pull_request_template.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,15 @@ for an explanation on how to use task lists-->
2424

2525
<!-- Please check if the following steps are OK:-->
2626

27-
- [ ] My tutorial or article is placed in a subfolder of `tutorials/content`
27+
- [ ] My tutorial or article is placed in a subfolder of `tutorials/content/`
28+
- [ ] The novel tutorial has a meaningful name, in relation to the content of the tutorial.
2829
- [ ] The filename of my tutorial or article is `index.md`. In case of an Rmarkdown tutorial I have knitted my `index.Rmd` to `index.md` (both files are pushed to the repo).
29-
- [ ] I have included `tags` in the YAML header (see the tags listed in the [tutorials website side bar](https://inbo.github.io/tutorials/) for tags that have been used before)
30-
- [ ] I have added `categories` to the YAML header and my category tags are from the [list of category tags](https://github.com/inbo/tutorials/blob/master/static/list_of_categories)
31-
- [ ] I have previewed this PR locally (see steps below) and confirmed that the new content renders as expected.
30+
- `yaml` header:
31+
- [ ] *(recommended)* I am included as author in the `authors` yaml tag, using `[MY_AUTHOR_ID]`. An author information file exists in `<tutorials>/data/authors/<author>.toml`.
32+
- [ ] I have added `categories` to the YAML header and my category tags are from the [list of category tags](https://github.com/inbo/tutorials/blob/master/static/list_of_categories)
33+
- [ ] *(optional)* I have included `tags` in the YAML header (see the tags listed in the [tutorials website side bar](https://inbo.github.io/tutorials/) for tags that have been used before)
34+
- [ ] The `date` is in format `YYYY-MM-DD` and adjusted.
35+
- [ ] *(recommended)* I have previewed this PR locally (see steps below; ask previous contributors for help) and confirmed that the new content renders as expected.
3236

3337

3438
## Previewing the pull request
@@ -40,8 +44,14 @@ This provides a way to preview how these updates will look on the website, usefu
4044

4145
1) On the PR page, you can find a "details" link under "checks - On PR, build the site and ...". Go there, click on the top link in the left sidebar ("Summary"), and download the generated artifact at the bottom of the page.
4246
2) Decompress it into a target directory, e.g. `Downloads/tutorials_preview`.
43-
3) To preview the website, use a program which can serve `http` sites on your local machine. One such option is [the `servr` package](https://github.com/yihui/servr) in R: `& '\C:\Program Files\R\R-4.4.2\bin\Rscript.exe' -e "servr::httd('./tutorials_preview')" -p8887`
47+
3) To preview the website, use a program which can serve `http` sites on your local machine. One such option is [the `servr` package](https://github.com/yihui/servr) in R: `& '\C:\Program Files\R\R-4.4.2\bin\Rscript.exe' -e "servr::httd('./tutorials_preview')" -p8887` (*make sure to adjust the path to your `Rscript.exe`*).
4448
4) Point your browser to http://localhost:8887.
4549
5) Review the updated website. As a contributor, you can push extra commits to update the PR. As a reviewer, you can accept/refuse/comment the PR.
4650

4751
**Note: for step 3, you can use any other simple HTTP server to serve the current directory, e.g. [Python `http.server`](https://docs.python.org/3/library/http.server.html): `python -m http.server 8887 --bind localhost --directory path/to/tutorials_preview`**
52+
53+
54+
### Alternative: Locally Building the Site
55+
56+
Alternatively, you can build the entire site locally ([see the README for instructions](https://github.com/inbo/tutorials?tab=readme-ov-file#building-the-site)); the Hugo preview server will update changes on the fly.
57+
This requires [Hugo](https://gohugo.io/getting-started) to be installed on your computer.

0 commit comments

Comments
 (0)