Update PR template (pipe-cd#4479)

Signed-off-by: khanhtc1202 <[email protected]>
sZma5a · Jul 11, 2023 · e716a80 · e716a80
1 parent 15c5c89
commit e716a80
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -6,6 +6,6 @@ Fixes #
 
 **Does this PR introduce a user-facing change?**:
 
+- **How are users affected by this change**:
 - **Is this breaking change**:
 - **How to migrate (if breaking change)**:
-- **How are users affected by this change**:
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -79,7 +79,7 @@ PipeCD consists of several components and docs:
 - **web**: The web application provided by the control plane.
 - **docs**: Documentation and references.
 
-You can find detailed development information in the README file of each directory.
+**You can find detailed development information in the README file of each directory.**
 
 ### Online one-click setup for contributing
 
@@ -134,17 +134,19 @@ By contributing to PipeCD, you agree that your contributions will be licensed un
 // limitations under the License.
 ```
 
-### Breaking Changes
+### Release Note and Breaking Changes
 
-When introducing a new breaking change, follow the pull request template and make sure to complete the following sections:
+If your change introcudes a user-facing change, please update the following section in your PR description.
 
 ```md
 **Does this PR introduce a user-facing change?**:
+- **How are users affected by this change**:
 - **Is this breaking change**:
 - **How to migrate (if breaking change)**:
-- **How are users affected by this change**:
 ```
 
+Note that if it's a new breaking change, make sure to complete the two latter questions.
+
 ## Contributor License Agreement
 
 For any code contribution, please carefully read the following documents: