Skip to content

Commit

Permalink
Updated the PR Request Template (#2097)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
misilot authored May 3, 2022
1 parent a59c116 commit 09efb4a
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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._
<!-- 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._
<!-- 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._
<!-- Document the details that help a reviewer verify the documentation. -->

## Interested Parties
<!-- Name some folks who may be interested, if documentation related mention @Islandora/documentation, or, if unsure, @Islandora/committers_ -->


> _**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?
Expand Down

0 comments on commit 09efb4a

Please sign in to comment.