diff --git a/.github/PULL_REQUEST_TEMPLATE/hcp_pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/hcp_pull_request_template.md new file mode 100644 index 0000000000..9ed4dec44e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/hcp_pull_request_template.md @@ -0,0 +1,55 @@ +## Description + + + +:ticket: [Jira ticket] + + + + + +### Requested review scope: + +- [ ] Content touched by the PR _only_ (typos, clarifications, tips) +- [ ] Code test (command and code block changes) +- [ ] Flow and language near changes (new/rearranged steps) +- [ ] Review everything (rewrites, major changes) + +### Review urgency: + +- [ ] ASAP (bug fixes, broken content, imminent releases) +- [ ] 3 days (small changes, easy reviews) +- [ ] 1 week (default) +- [ ] Best effort (very non-urgent) + + + +## All updates: + + + +I have: + +- [ ] Verified that all status checks have passed +- [ ] Verified that preview environment has successfully deployed +- [ ] Verified appropriate `label` applied (`hcp` + `product name`) +- [ ] Added all required reviewers (code owners and external) + +## Content checklist (optional) + +Please do these things before requesting a review. I have: + +- [ ] Made any associated code repositories public +- [ ] Added the `hashicorp-education/teamName` to any additional code or example repos as repo admin +- [ ] Added redirects for any moved or removed pages +- [ ] Spell checked the tutorial(s) +- [ ] Followed the [unified style guide](https://github.com/hashicorp/web-unified-docs/tree/main/docs/style-guide) +- [ ] Linted code snippets (Details per language [here](https://github.com/hashicorp/engineering-docs/blob/master/writing/markdown.md#code-blocks)) +- [ ] Checked the steps for completeness (no steps are implied or hidden) +- [ ] Looked at the local or vercel build and checked each new or changed page for: + - display on the product curriculum page + - callout box formatting + - code block highlighting + - right-hand navigation + - next and back buttons + - URL path diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..9983da36c9 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,4 @@ +Please go to the `Preview` tab and select the appropriate template: + +* [HCP services](?expand=1&template=hcp_pull_request_template.md) +* [Terraform Enterprise](?expand=1&template=ptfe_release_pull_request_template.md)