diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 111503fb..201f64df 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,17 +1,27 @@ ## Issue resolution - Closes # +## Objectives + +Objectives: +- Objective 1 +- Objective 2 +- ... +- Objective n + Select one: This pull request is... - [ ] a bug fix: increment the patch version - [ ] a small improvement: increment the minor version - [ ] a new feature: increment the minor version - [ ] an incompatible (non-backwards compatible) API change: increment the major version -Please fill out either the "Small Change" or "Big Change" section, and delete the other. +Please fill out either the "Small Change" or "Big Change" section (the latter includes the numbered subsections), and delete the other. ## Small Change - [ ] To merge, I will use "Squash and merge". That is, this change should be a single commit. +- [ ] Logic: I have visually inspected the entire pull request myself. +- [ ] Pre-commit checks: All the pre-commits checks have passed. ## Big Change @@ -19,12 +29,6 @@ Please fill out either the "Small Change" or "Big Change" section, and delete th ### 1. Does this do what we want it to do? -Objectives: -- Objective 1 -- Objective 2 -- ... -- Objective n - Required: - [ ] Product Management: I have confirmed with the stakeholders that the objectives above are correct and complete. - [ ] Testing: I have added or modified at least one "min-case" configuration file to test this change. Every objective above is represented in at least one cfg.