Skip to content

Commit 8322742

Browse files
Add PR template, and HCP doc specific template (#1030)
Add PR template selector (default PR template) and HCP doc template. Example of main template allowing someone to tack on their desired template <img width="1358" height="782" alt="image" src="https://github.com/user-attachments/assets/01e3780a-ce03-4e7f-906e-aa9314ce0bcb" />
2 parents 1d31549 + 1dbc37e commit 8322742

File tree

2 files changed

+59
-0
lines changed

2 files changed

+59
-0
lines changed
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
## Description
2+
3+
<!-- ID for Jira ticket e.g [SPE-1234] -->
4+
5+
:ticket: [Jira ticket]
6+
7+
<!-- Add a brief description of changes here. Include any other necessary relevant links -->
8+
9+
<!-- Help your reviewer understand the type of review you need by selecting the scope and urgency. -->
10+
11+
### Requested review scope:
12+
13+
- [ ] Content touched by the PR _only_ (typos, clarifications, tips)
14+
- [ ] Code test (command and code block changes)
15+
- [ ] Flow and language near changes (new/rearranged steps)
16+
- [ ] Review everything (rewrites, major changes)
17+
18+
### Review urgency:
19+
20+
- [ ] ASAP (bug fixes, broken content, imminent releases)
21+
- [ ] 3 days (small changes, easy reviews)
22+
- [ ] 1 week (default)
23+
- [ ] Best effort (very non-urgent)
24+
25+
<!-- Fill out only the appropriate checklist for your type of feature (or both if necessary) and delete the other one! -->
26+
27+
## All updates:
28+
29+
<!-- This section is mandatory for all PRs: -->
30+
31+
I have:
32+
33+
- [ ] Verified that all status checks have passed
34+
- [ ] Verified that preview environment has successfully deployed
35+
- [ ] Verified appropriate `label` applied (`hcp` + `product name`)
36+
- [ ] Added all required reviewers (code owners and external)
37+
38+
## Content checklist (optional)
39+
40+
Please do these things before requesting a review. I have:
41+
42+
- [ ] Made any associated code repositories public
43+
- [ ] Added the `hashicorp-education/teamName` to any additional code or example repos as repo admin
44+
- [ ] Added redirects for any moved or removed pages
45+
- [ ] Spell checked the tutorial(s)
46+
- [ ] Followed the [unified style guide](https://github.com/hashicorp/web-unified-docs/tree/main/docs/style-guide)
47+
- [ ] Linted code snippets (Details per language [here](https://github.com/hashicorp/engineering-docs/blob/master/writing/markdown.md#code-blocks))
48+
- [ ] Checked the steps for completeness (no steps are implied or hidden)
49+
- [ ] Looked at the local or vercel build and checked each new or changed page for:
50+
- display on the product curriculum page
51+
- callout box formatting
52+
- code block highlighting
53+
- right-hand navigation
54+
- next and back buttons
55+
- URL path

.github/pull_request_template.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Please go to the `Preview` tab and select the appropriate template:
2+
3+
* [HCP services](?expand=1&template=hcp_pull_request_template.md)
4+
* [Terraform Enterprise](?expand=1&template=ptfe_release_pull_request_template.md)

0 commit comments

Comments
 (0)