From ba179a1883ad9afdd25a12cbec5add7f4cc91647 Mon Sep 17 00:00:00 2001 From: jonathanfrappier <92055993+jonathanfrappier@users.noreply.github.com> Date: Wed, 1 Oct 2025 12:21:22 -0400 Subject: [PATCH 1/3] Add PR template, and HCP doc specific template --- .../hcp_pull_request_template.md | 55 +++++++++++++++++++ .github/pull_request_template.md | 4 ++ 2 files changed, 59 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/hcp_pull_request_template.md create mode 100644 .github/pull_request_template.md 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..6dbe2ea1fc --- /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 +- [ ] Assigned an appropriate `label` (`hcp` + `product name`) +- [ ] Requested at least one reviewer + +## 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) From 1529ab3b21807819dc30c3ca1a5881f5164c883d Mon Sep 17 00:00:00 2001 From: jonathanfrappier <92055993+jonathanfrappier@users.noreply.github.com> Date: Wed, 1 Oct 2025 20:44:28 -0400 Subject: [PATCH 2/3] Suggested changes --- .github/PULL_REQUEST_TEMPLATE/hcp_pull_request_template.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/hcp_pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/hcp_pull_request_template.md index 6dbe2ea1fc..a0a70a59b2 100644 --- a/.github/PULL_REQUEST_TEMPLATE/hcp_pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/hcp_pull_request_template.md @@ -1,8 +1,8 @@ ## Description - + -:ticket: [Jira ticket]() +:ticket: [Jira ticket] @@ -33,7 +33,7 @@ I have: - [ ] Verified that all status checks have passed - [ ] Verified that preview environment has successfully deployed - [ ] Assigned an appropriate `label` (`hcp` + `product name`) -- [ ] Requested at least one reviewer +- [ ] Added all required reviewers (code owners and external) ## Content checklist (optional) From 216d610d9eb21df29bf0af1c97734120a1b12731 Mon Sep 17 00:00:00 2001 From: jonathanfrappier <92055993+jonathanfrappier@users.noreply.github.com> Date: Thu, 2 Oct 2025 09:43:00 -0400 Subject: [PATCH 3/3] Updated steps for PR config --- .github/PULL_REQUEST_TEMPLATE/hcp_pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/hcp_pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/hcp_pull_request_template.md index a0a70a59b2..9ed4dec44e 100644 --- a/.github/PULL_REQUEST_TEMPLATE/hcp_pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/hcp_pull_request_template.md @@ -32,7 +32,7 @@ I have: - [ ] Verified that all status checks have passed - [ ] Verified that preview environment has successfully deployed -- [ ] Assigned an appropriate `label` (`hcp` + `product name`) +- [ ] Verified appropriate `label` applied (`hcp` + `product name`) - [ ] Added all required reviewers (code owners and external) ## Content checklist (optional)