This repository has been archived by the owner on Sep 24, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 170
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #228 from barbaricyawps/move-pr-template
Update pull request template
- Loading branch information
Showing
1 changed file
with
105 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,105 @@ | ||
| > __ALL Pull-Requests require an associated [Issue](https://github.com/thegooddocsproject/templates/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) as documented in [How to contribute](https://github.com/thegooddocsproject/templates/blob/master/CONTRIBUTING.md#contributing).__ | ||
| ## Purpose / why | ||
|
|
||
| > _**Replace this text** - Restate the purpose/justification of this work and include links to the Issue inside of the purpose/why._ | ||
| ## What changes were made? | ||
|
|
||
| > _**Replace this text** - State clearly the direct additions or modifications made in this change-request._ | ||
| ## Verification | ||
|
|
||
| > _**Replace this text** - Document the details that help a reviewer understand what steps or actions should be taken in-order to verify the work is completed and satisfies the initial scope of work._ | ||
| --- | ||
|
|
||
| ## Checklist | ||
|
|
||
| > __Pull-request reviewer__ should ensure the following | ||
| * [ ] Are issues linked correctly? | ||
| * [ ] Is this PR labeled correctly? | ||
| * [ ] If template updates: do they align with [developers.google.com/style/](https://developers.google.com/style/)? | ||
| * [ ] Did the PR receive at least one :+1: and no :-1: from core-maintainers? | ||
| * [ ] On merging, did you complete the merge using [keywords](https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#manually-linking-a-pull-request-to-an-issue)? | ||
| * [ ] On merging, did you add any applicable notes to a [draft release](https://github.com/thegooddocsproject/templates/releases) and link to this PR? | ||
| # Template quality checklist | ||
|
|
||
| This quality checklist will eventually become a pull request template that every contributor needs to add to pull requests against the `templates` repository. | ||
|
|
||
|
|
||
| # Pull request summary | ||
|
|
||
| {Describe the purpose of your pull request.} | ||
|
|
||
| {Also indicate which template working group you belong to and who your template mentor is.} | ||
|
|
||
| ## Template contributor checklist | ||
|
|
||
| IMPORTANT: The next three sections in this checklist should be filled out by the template contributor at the time they submit this request. | ||
|
|
||
| NOTE: Pull requests can only be merged when all boxes are checked. | ||
|
|
||
| ### Which issue does this pull request fix or reference? | ||
|
|
||
| This pull request: | ||
|
|
||
| - Resolves: {Choose this option if this PR will close the issue and link to issue} | ||
| - Relates to: {Choose this option if this PR only references an issue for context but does not fully resolve it} | ||
|
|
||
| ### Procedural requirements | ||
|
|
||
| - [ ] The template contributor participated in a template working group to create this template. | ||
| - [ ] This template was submitted to the community for feedback. | ||
| - [ ] A template mentor approved this template set to move to the pull request phase. | ||
|
|
||
|
|
||
| ### Template set requirements | ||
|
|
||
| - [ ] Template file is present. | ||
| - [ ] Template guide is present. | ||
| - [ ] Template deep dive is present (optional). | ||
| - [ ] Template example is present (optional). | ||
| - [ ] If the optional template example is not present, open a new issue was created to track this task (include link). | ||
|
|
||
|
|
||
| ## Template pull request reviewer checklist | ||
|
|
||
| IMPORTANT: The rest of the sections in this checklist should only be filled out by authorized Good Docs Project pull request reviewers. If you are the individual template contributor, do not fill out the rest of the fields or check the boxes. | ||
|
|
||
| NOTE: Pull requests can only be merged when all boxes are checked. | ||
|
|
||
|
|
||
| ### Mechanics and formatting requirements - PULL REQUEST REVIEWER ONLY | ||
|
|
||
| - [ ] Check rendered Markdown output to ensure it renders correctly. | ||
| - [ ] Review the template set to ensure all documents follow the template markdown style guide. | ||
| - [ ] The template set is free from grammar errors and typos. | ||
|
|
||
|
|
||
| ### Overall usability - PULL REQUEST REVIEWER ONLY | ||
|
|
||
| - [ ] The scope of the template set is appropriate, meaning it is not too simple or overly complex (i.e. it needs to be expanded or broken into multiple smaller templates). | ||
| - [ ] The template is complete and comphrehensive. | ||
| - [ ] The template set is well-organized and the contents flow in a logical order. | ||
| - [ ] The template is well-written and clear. | ||
| - [ ] The template set provides sufficient guidance about how to fill it in and implement the template in a documentation project. | ||
|
|
||
|
|
||
| ### Template file requirements - PULL REQUEST REVIEWER ONLY | ||
|
|
||
| - [ ] Check rendered Markdown output to ensure it renders correctly and follows the template markdown style guide. | ||
| - [ ] The template title is present and is an H1. | ||
| - [ ] The template includes an introductory comment mentioning the other template resources (such as the guide). | ||
| - [ ] Embedded writing tips are formatted with {curly brackets}. | ||
| - [ ] The template is free from grammar errors and typos. | ||
| - [ ] The scope of the template is appropriate, meaning it is not too simple or overly complex (i.e. it needs to be expanded or broken into multiple smaller templates). | ||
| - [ ] The template is complete and comphrehensive. | ||
| - [ ] The template is well-organized and the contents flow in a logical order. | ||
| - [ ] The template is well-written and clear. | ||
|
|
||
|
|
||
| ### Template guide requirements - PULL REQUEST REVIEWER ONLY | ||
|
|
||
| - [ ] Check rendered Markdown output to ensure it renders correctly and follows the template markdown style guide. | ||
| - [ ] The template guide title is present and is an H1. | ||
| - [ ] The template includes an introductory comment pointing them to other template resources. | ||
| - [ ] Embedded writing tips are formatted with {curly brackets}. | ||
| - [ ] The template guide is free from grammar errors and typos. | ||
| - [ ] The template guide includes a "Why do I need this type of document?" section. | ||
| - [ ] The template guide includes a "Contents of this template" section. | ||
| - [ ] The contents listed in the "Contents of this template" section mirror the sections in the raw template. | ||
| - [ ] The template guide includes an implementation checklist (optional). | ||
| - [ ] The template guide includes additional resources (optional). | ||
| - [ ] The template guide is well-organized and the contents flow in a logical order. | ||
| - [ ] The template guide is well-written, clear, and provides sound advice to template users. | ||
|
|
||
|
|
||
| ### Deep dive requirements (optional) - PULL REQUEST REVIEWER ONLY | ||
|
|
||
| - [ ] Check rendered Markdown output to ensure it renders correctly and follows the template markdown style guide. | ||
| - [ ] The deep drive title is present and is an H1. | ||
| - [ ] The deep dive guide provides helpful advice about necessary requirements for writing this type of documentation. | ||
| - [ ] The template set is well-organized and the contents flow in a logical order. | ||
| - [ ] The template is well-written and clear. | ||
|
|
||
|
|
||
| ### Template example requirements (optional) - PULL REQUEST REVIEWER ONLY | ||
|
|
||
| - [ ] Check rendered Markdown output to ensure it renders correctly and follows the template markdown style guide. | ||
| - [ ] The template example provided is well-written and provides a clear example of how to use the template. |