From 1710f59688c59fe31bda89c023f0903c1b67ae6a Mon Sep 17 00:00:00 2001 From: Josh Black Date: Tue, 11 Jun 2024 11:48:27 -0700 Subject: [PATCH] add PR template (#27392) * 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 * further feedback --------- Co-authored-by: Violet Hynes --- .github/docs/pull_request_template.md | 8 ++++++++ .github/pull_request_template.md | 24 ++++++++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 .github/docs/pull_request_template.md create mode 100644 .github/pull_request_template.md diff --git a/.github/docs/pull_request_template.md b/.github/docs/pull_request_template.md new file mode 100644 index 0000000000..6b9d11b9a1 --- /dev/null +++ b/.github/docs/pull_request_template.md @@ -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. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..bf5e3da89c --- /dev/null +++ b/.github/pull_request_template.md @@ -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.