Update PR template

E3SM-Project · Jan 14, 2025 · b5736a2 · b5736a2
1 parent ccbf4dd
commit b5736a2
Showing 1 changed file with 15 additions and 4 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -4,9 +4,20 @@
 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
 
-## 1. Does this do what we want it to do?
+Please fill out either the "Small Change" or "Big Change" section, and delete the other.
+
+## Small Change
+
+- [ ] To merge, I will use "Squash and merge". That is, this change should be a single commit.
+
+## Big Change
+
+- [ ] To merge, I will use "Create a merge commit". That is, this change is large enough to require multiple units of work (i.e., it should be multiple commits).
+
+### 1. Does this do what we want it to do?
 
 Objectives:
 - Objective 1
@@ -23,7 +34,7 @@ If applicable:
 - [ ] Testing: this pull request introduces an important feature or bug fix that we _must_ test often. I have updated the weekly-test configuration files, not just a "min-case" one.
 - [ ] Testing: this pull request adds at least one new possible parameter to the cfg. I have tested using this parameter with and without any other parameter that may interact with it.
 
-## 2. Are the implementation details accurate & efficient?
+### 2. Are the implementation details accurate & efficient?
 
 Required:
 - [ ] Logic: I have visually inspected the entire pull request myself.
@@ -32,12 +43,12 @@ Required:
 If applicable:
 - [ ] Dependencies: This pull request introduces a new dependency. I have discussed this requirement with at least one other team member. The dependency is noted in `zppy/conda`, not just an `import` statement.
 
-## 3. Is this well documented?
+### 3. Is this well documented?
 
 Required:
 - [ ] Documentation: by looking at the docs, a new user could easily understand the functionality introduced by this pull request.
 
-## 4. Is this code clean?
+### 4. Is this code clean?
 
 Required:
 - [ ] Readability: The code is as simple as possible and well-commented, such that a new team member could understand what's happening.