diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..c131c05a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,34 @@ + +### Summary + + + +Fixes # + +*Lorem ipsum dolor sit amet, consectetur adipiscing.* + +### List of changes proposed in this PR (pull-request) + + + +* *Lorem ipsum dolor sit amet, consectetur adipiscing.* +* *Lorem ipsum dolor sit amet, consectetur adipiscing.* + +### Some housekeeping checks + +- [ ] If you have added a new blog: + - [ ] Did you preview it locally using `quarto render`? + - [ ] Is the blog source file listed within the correct year's sub-directory? + - [ ] If you are using any images in the blog, are they [optimised](https://github.com/forwards/forwards.github.io?tab=readme-ov-file#optimizing-images)? There is a script available in [R/optimize_photo.R](https://github.com/forwards/forwards.github.io/blob/main/R/optimize_photo.R) to optimise the images. + - [ ] Did you go through the [Editing checklist](https://github.com/forwards/forwards.github.io/blob/main/README.md#editing-checklist)? + - [ ] Have you set `draft: false` in the YAML header? + - [ ] Have you updated the post date? + +### What should a reviewer concentrate their feedback on? + + + +- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.* +- [ ] Everything looks ok? diff --git a/README.md b/README.md index 7a5b3380..5d78f2db 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ dir.create("blog/2023/example-blog-post") where the name of the directory defines the URL of your post. -Within the subdirectory, create a new file, `index.Rmd`, with the following header +Within the subdirectory, create a new file, `index.qmd`, with the following header ```yaml --- @@ -84,7 +84,7 @@ refer them without a file path. * Update the post date. * Check the blog source file is within the correct year's sub-directory. -* Set `draft:false` in the YAML header +* Set `draft: false` in the YAML header * Click "Render website" on the Build tab in RStudio, or in the terminal run quarto render