-
Notifications
You must be signed in to change notification settings - Fork 82
Add PR template, and HCP doc specific template #1030
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
jonathanfrappier
wants to merge
5
commits into
main
Choose a base branch
from
chore/add-pr-template
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
ba179a1
Add PR template, and HCP doc specific template
jonathanfrappier 6439a4b
Merge branch 'main' into chore/add-pr-template
jonathanfrappier 1529ab3
Suggested changes
jonathanfrappier 216d610
Updated steps for PR config
jonathanfrappier 1dbc37e
Merge branch 'main' into chore/add-pr-template
jonathanfrappier File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
55 changes: 55 additions & 0 deletions
55
.github/PULL_REQUEST_TEMPLATE/hcp_pull_request_template.md
This file contains hidden or 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 |
---|---|---|
@@ -0,0 +1,55 @@ | ||
## Description | ||
|
||
<!-- ID for Jira ticket e.g [SPE-1234] --> | ||
|
||
:ticket: [Jira ticket] | ||
|
||
<!-- Add a brief description of changes here. Include any other necessary relevant links --> | ||
|
||
<!-- Help your reviewer understand the type of review you need by selecting the scope and urgency. --> | ||
|
||
### 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) | ||
|
||
<!-- Fill out only the appropriate checklist for your type of feature (or both if necessary) and delete the other one! --> | ||
|
||
## All updates: | ||
|
||
<!-- This section is mandatory for all PRs: --> | ||
|
||
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 |
This file contains hidden or 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 |
---|---|---|
@@ -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) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❤️