From 09efb4addc2f36c865b5e42ec9e46bd94ef61449 Mon Sep 17 00:00:00 2001 From: Tom Misilo <1446856+misilot@users.noreply.github.com> Date: Tue, 3 May 2022 11:47:34 -0500 Subject: [PATCH] Updated the PR Request Template (#2097) Instead of having the user replace the text, I put the directions in comments, and put the checklist more into unique sections for Reviewer and Commiter. --- .github/PULL_REQUEST_TEMPLATE.md | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7de29c200..2a0e9188e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,31 +1,30 @@ ## Purpose / why - -> _**Replace this text** - Restate the purpose/justification of this work and include links to any Issues or other discussions that are related to this work._ + ## What changes were made? - -> _**Replace this text** - State clearly the direct additions or modifications made in this pull request._ + ## Verification - -> _**Replace this text** - Document the details that help a reviewer verify the documentation._ + ## Interested Parties + - -> _**Replace this text** - Name some folks who may be interested, if documentation related mention @Islandora/documentation, or, if unsure, @Islandora/committers_ - ---- +* @Islandora/documentation +* @Islandora/committers ## Checklist -> __Pull-request reviewer__ should ensure the following +### Pull-request Reviewer +Pull-request reviewer should ensure the following: * [ ] Does this PR link to related [issues](https://github.com/Islandora/documentation/issues/)? * [ ] Does the proposed documentation align with the [Islandora Documentation Style Guide](https://islandora.github.io/documentation/contributing/docs_style_guide/)? * [ ] Are the changes accurate, useful, free of typos, etc? -> __Person merging__ should ensure the following +### Person Merging +The person merging should ensure the following: + * [ ] Does mkdocs still build successfully? (This is indicated by TravisCI passing. To test locally, and see warnings, see [How To Build Documentation](https://islandora.github.io/documentation/technical-documentation/docs-build/).) * [ ] If pages are renamed or removed, have all internal links to those pages been fixed? * [ ] If pages are added, have they been linked to or placed in the menu?