From ff7815e4fd29485b19c26a205d86f4c8a24bd159 Mon Sep 17 00:00:00 2001 From: James Rasell Date: Fri, 8 Nov 2024 10:09:33 +0000 Subject: [PATCH] admin: add GitHub PR template. (#24365) The template aims to ensure all PRs include the required information for reviewers. The checklist items help ensure merging happens quickly and in the correct manner. Co-authored-by: Tim Gross --- .github/pull_request_template.md | 35 ++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..6f45b095e --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,35 @@ +### Description + + +### Testing & Reproduction steps + + +### Links + + +### Contributor Checklist +- [ ] **Changelog Entry** If this PR changes user-facing behavior, please generate and add a + changelog entry using the `make cl` command. +- [ ] **Testing** Please add tests to cover any new functionality or to demonstrate bug fixes and + ensure regressions will be caught. +- [ ] **Documentation** If the change impacts user-facing functionality such as the CLI, API, UI, + and job configuration, please update the Nomad website documentation to reflect this. Refer to + the [website README](../website/README.md) for docs guidelines. Please also consider whether the + change requires notes within the [upgrade guide](../website/content/docs/upgrade/upgrade-specific.mdx). + +### Reviewer Checklist +- [ ] **Backport Labels** Please add the correct backport labels as described by the internal + backporting document. +- [ ] **Commit Type** Ensure the correct merge method is selected which should be "squash and merge" + in the majority of situations. The main exceptions are long-lived feature branches or merges where + history should be preserved. +- [ ] **Enterprise PRs** If this is an enterprise only PR, please add any required changelog entry + within the public repository.