Skip to content

Commit 3f756be

Browse files
authored
Repo infra: Add PR template for Nomad (#1189)
Add PR template for Nomad content. Nomad is scheduled to move Nov 18. Jira: [CE-1066] [CE-1066]: https://hashicorp.atlassian.net/browse/CE-1066?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
2 parents 4866170 + 743033f commit 3f756be

File tree

2 files changed

+80
-0
lines changed

2 files changed

+80
-0
lines changed
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
<!--
2+
**Merge branch**
3+
4+
Make sure you create your PR against the correct **base** branch. For instructions, refer to
5+
GitHub's **Change the branch range and destination repository guide** (https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
6+
7+
If your content is an update to:
8+
9+
- Currently published content
10+
11+
Choose **base: main** when you are updating published documentation, and you
12+
want your changes published when the PR is merged. We publish Nomad content
13+
from the `main` branch.
14+
- Upcoming Nomad release
15+
16+
Choose the branch for the Nomad release that your content is for. Nomad
17+
release branches use the `nomad/<exact-release-number>` format. If you are not
18+
able to find the upcoming Nomad release branch that you are looking for,
19+
contact the tech writer that works with the Nomad team.
20+
21+
**Backports**
22+
23+
This repo stores previous version docs in folders instead of branches. There are
24+
no backport labels. If you backported your code PR to previous branches, update
25+
the docs content in the corresponding folders. For example, if the current
26+
release is 1.10.x and you backported your code to 1.9.x and 1.8.x, update the docs content
27+
in the v1.10.x, v1.9.x, and v1.8.x folders.
28+
-->
29+
30+
## Description
31+
32+
<!-- Please describe why you're making this change and point out any important details the reviewers
33+
should be aware of.
34+
35+
Include the target release as well as prior versions if applicable.
36+
-->
37+
38+
## Links
39+
<!--
40+
Please include links to GitHub issues, documentation, or similar which is relevant to this PR. If
41+
this is a bug fix, please ensure related issues are linked so they will close when this PR is
42+
merged.
43+
44+
Jira: [<jira-ticket-number>] // for example, Jira: [CE-1001] GH-Jira integration generates the link and updates the Jira ticket.
45+
GitHub Issue: <issue-link>
46+
Deploy previews:
47+
48+
The bot does publish a root-level link to the deploy preview,
49+
but it's nice to include a direct link to your content so the reviewers don't have to navigate to your pages.
50+
-->
51+
52+
## Contributor checklists
53+
54+
Review urgency:
55+
56+
- [ ] ASAP: Bug fixes, broken content, imminent releases
57+
- [ ] 3 days: Small changes, easy reviews
58+
- [ ] 1 week: Default expectation
59+
- [ ] Best effort: No urgency
60+
61+
Pull request:
62+
63+
- [ ] Verify that the PR is set to merge into the correct base branch
64+
- [ ] Verify that all status checks passed
65+
- [ ] Verify that the preview environment deployed successfully
66+
- [ ] Add additional reviewers if they are not part of assigned groups
67+
68+
Content:
69+
70+
- [ ] I added redirects for any moved or removed pages
71+
- [ ] I followed the [Education style guide](https://github.com/hashicorp/web-unified-docs/tree/main/docs/style-guide)
72+
- [ ] I looked at the local or Vercel build to make sure the content rendered correctly
73+
74+
## Reviewer checklist
75+
76+
- [ ] This PR is set to merge into the correct base branch.
77+
- [ ] The content does not contain technical inaccuracies.
78+
- [ ] The content follows the Education content and style guides.
79+
- [ ] I have verified and tested changes to instructions for end users.

.github/pull_request_template.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
Please go to the `Preview` tab and select the appropriate template:
22

33
* [HCP services](?expand=1&template=hcp_pull_request_template.md)
4+
* [Nomad](?expand=1&labels=Nomad&title=Nomad+Docs&template=nomad_pull_request_template.md)
45
* [Terraform Enterprise](?expand=1&template=ptfe_release_pull_request_template.md)

0 commit comments

Comments
 (0)