Skip to content

Commit 29bf515

Browse files
authored
Merge pull request #306 from inbo/pr_template
Update PR template
2 parents 817d46a + b094220 commit 29bf515

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

.github/pull_request_template.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,14 @@ for an explanation on how to use task lists-->
3333
## Previewing the pull request
3434

3535
Thanks to GitHub Actions, an artifact (=zip file) of the rendered website is automatically created for each pull request.
36+
This provides a way to preview how these updates will look on the website, useful to contributors and reviewers.
3637

37-
### Instructions
38+
### Instructions to preview the updated website
3839

3940
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.
4041
2) Decompress it and make sure the target directory is called 'tutorials' (you may need to rename it)
4142
3) From the parent directory (just above the `tutorials` folder you created/renamed), run `python -m http.server 8887`, _or_ launch the Google Chrome [Web Server app](https://chrome.google.com/webstore/detail/web-server-for-chrome/ofhbbkphhbklhfoeikjpcbhemlocgigb) and point it at the parent directory.
4243
4) Point your browser to http://localhost:8887/tutorials.
43-
5) Review the updated website and accept/refuse/comment the PR
44+
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.
4445

45-
**Note: for step 3, you can use any other simple HTTP server to serve the current directory if you don't have a Python 3 environment or Google Chrome available.**
46+
**Note: for step 3, you can use any other simple HTTP server to serve the current directory if you don't have a Python 3 environment or Google Chrome available.**

0 commit comments

Comments
 (0)