Closed LienReyserhove closed 2 years ago
Thanks for pinpointing confusing things. Considering the 'why': the 'instructions' title is a subtitle of:
Previewing the pull request
Thanks to GitHub Actions, an artifact (=zip file) of the rendered website is automatically created for each pull request.
If the title 'Instructions' were modified to 'Instructions to render the updated website triggered by the pull request ', would this clarify? In essence, it is a way to preview how your contribution will render after merging, so both the PR author(s) and reviewers can use that for reviewing or further checking.
Step 5, it seems, is only formulated for reviewers, not contributors, so that is better extended. Also, the above cited paragraph could be extended by 'This is a way to preview how your contribution will render ...' as just explained.
You're most welcome to improve it based on these explanations and your own insights; the file to update is https://github.com/inbo/tutorials/blob/master/.github/pull_request_template.md. Also it seems that the file REVIEWING.md
, where that information originally resided, is still linked in https://github.com/inbo/tutorials#reviewing-the-website-in-a-pull-request-before-merging, currently a dead link so that's also something to update. See also https://github.com/inbo/tutorials/pull/278, where this move happened, and where you also find some additional explanation about the workflow, also regarding step 3.
Also it seems that the file REVIEWING.md, where that information originally resided, is still linked in https://github.com/inbo/tutorials#reviewing-the-website-in-a-pull-request-before-merging, currently a dead link so that's also something to update.
See also issue #292. Solved by PR #296.
Upon making the PR for #290, the following instructions are quite complex for me.
So perhaps some justification and simplification might be interesting here? It depends on who's making a PR of course.