scottk/vault
1
0
Fork 0
mirror of https://github.com/optim-enterprises-bv/vault.git synced 2025-10-30 18:17:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

add PR template (#27392)

Browse Source 
* add PR template

* adjustments

* PR feedback and add a docs template as well

* Update .github/docs/pull_request_template.md

Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com>

* further feedback

---------

Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com>
This commit is contained in:
Josh Black
2024-06-11 11:48:27 -07:00
committed by GitHub
parent 64316fa084
commit 1710f59688
2 changed files with 32 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
.github/docs/pull_request_template.md vendored Normal file
View File

@@ -0,0 +1,8 @@
### Description
Why is this docs change needed?
### TODO
- [ ] Preview the changes you made either locally or in the Vercel deployment
and make sure it looks correct.
- [ ] If you've added a new link to the sidebar navigation, make sure it's
sorted correctly.

24
.github/pull_request_template.md vendored Normal file
View File

@@ -0,0 +1,24 @@
### Description
What does this PR do?
### TODO only if you're a HashiCorp employee
- [ ] **Changelog:** Make sure there is one, or the `pr/no-changelog` label is
applied. Brand new features have a differently
formatted changelog than other changelogs, so pay attention to that. If this
PR is the CE portion of an ENT PR, put the changelog here, _not_ in your ENT
PR. Feel free to refer to the [instructions](https://github.com/hashicorp/vault/blob/main/CONTRIBUTING.md#changelog-entries) on changelog formatting if necessary.
- [ ] **Labels:** If this PR is the CE portion of an ENT change, and that ENT change is
getting backported to N-2, use the new style `backport/ent/x.x.x+ent` labels
instead of the old style `backport/x.x.x` labels.
- [ ] **Labels:** If this PR is a CE only change, it can only be backported to N, so use
the normal `backport/x.x.x` label (there should be only 1).
- [ ] **ENT Breakage:** If this PR either 1) removes a public function OR 2) changes the signature
of a public function, even if that change is in a CE file, _double check_ that
applying the patch for this PR to the ENT repo and running tests doesn't
break any tests. Sometimes ENT only tests rely on public functions in CE
files.
- [ ] **Jira:** If this change has an associated Jira, it's referenced either
in the PR description, commit message, or branch name.
- [ ] **RFC:** If this change has an associated RFC, please link it in the description.
- [ ] **ENT PR:** If this change has an associated ENT PR, please link it in the
description.