Add "Release Notes" section to PR templates

atom · Oct 29, 2018 · 89c3a39ff8d139f42032295aa447945eacaf885a · 89c3a39
1 parent d7ead4e
commit 89c3a39ff8d139f42032295aa447945eacaf885a
Unified Split

Showing with 72 additions and 0 deletions.

+18 −0 .github/PULL_REQUEST_TEMPLATE/bug_fix.md

+18 −0 .github/PULL_REQUEST_TEMPLATE/documentation.md

+18 −0 .github/PULL_REQUEST_TEMPLATE/feature_change.md

+18 −0 .github/PULL_REQUEST_TEMPLATE/performance_improvement.md
diff --git a/.github/PULL_REQUEST_TEMPLATE/bug_fix.md b/.github/PULL_REQUEST_TEMPLATE/bug_fix.md
@@ -39,3 +39,21 @@ We must be able to understand the design of your change from this description. I
 What process did you follow to verify that the change has not introduced any regressions? Describe the actions you performed (including buttons you clicked, text you typed, commands you ran, etc.), and describe the results you observed.
 -->
+  
+
+  
+### Release Notes
+  
+
+  
+<!--
+  
+
+  
+Please describe the changes in a single line that explains this improvement in
+  
+terms that a user can understand.  This text will be used in Atom's release notes.
+  
+
+  
+If this change is not user-facing or notable enough to be included in release notes
+  
+you may use the strings "Not applicable" or "N/A" here.
+  
+
+  
+Examples:
+  
+
+  
+- The GitHub package now allows you to add co-authors to commits.
+  
+- Fixed an issue where multiple cursors did not work in a file with a single line.
+  
+- Increased the performance of searching and replacing across a whole project.
+  
+
+  
+-->
diff --git a/.github/PULL_REQUEST_TEMPLATE/documentation.md b/.github/PULL_REQUEST_TEMPLATE/documentation.md
@@ -10,3 +10,21 @@
 We must be able to understand the purpose of your change from this description. If we can't get a good idea of the benefits of the change from the description here, the pull request may be closed at the maintainers' discretion.
 -->
+  
+
+  
+### Release Notes
+  
+
+  
+<!--
+  
+
+  
+Please describe the changes in a single line that explains this improvement in
+  
+terms that a user can understand.  This text will be used in Atom's release notes.
+  
+
+  
+If this change is not user-facing or notable enough to be included in release notes
+  
+you may use the strings "Not applicable" or "N/A" here.
+  
+
+  
+Examples:
+  
+
+  
+- The GitHub package now allows you to add co-authors to commits.
+  
+- Fixed an issue where multiple cursors did not work in a file with a single line.
+  
+- Increased the performance of searching and replacing across a whole project.
+  
+
+  
+-->
diff --git a/.github/PULL_REQUEST_TEMPLATE/feature_change.md b/.github/PULL_REQUEST_TEMPLATE/feature_change.md
@@ -50,3 +50,21 @@ What process did you follow to verify that your change has the desired effects?
 Describe the actions you performed (including buttons you clicked, text you typed, commands you ran, etc.), and describe the results you observed.
 -->
+  
+
+  
+### Release Notes
+  
+
+  
+<!--
+  
+
+  
+Please describe the changes in a single line that explains this improvement in
+  
+terms that a user can understand.  This text will be used in Atom's release notes.
+  
+
+  
+If this change is not user-facing or notable enough to be included in release notes
+  
+you may use the strings "Not applicable" or "N/A" here.
+  
+
+  
+Examples:
+  
+
+  
+- The GitHub package now allows you to add co-authors to commits.
+  
+- Fixed an issue where multiple cursors did not work in a file with a single line.
+  
+- Increased the performance of searching and replacing across a whole project.
+  
+
+  
+-->
diff --git a/.github/PULL_REQUEST_TEMPLATE/performance_improvement.md b/.github/PULL_REQUEST_TEMPLATE/performance_improvement.md
@@ -35,3 +35,21 @@ What process did you follow to verify that the change has not introduced any reg
 ### Applicable Issues
 <!-- Enter any applicable Issues here -->
+  
+
+  
+### Release Notes
+  
+
+  
+<!--
+  
+
+  
+Please describe the changes in a single line that explains this improvement in
+  
+terms that a user can understand.  This text will be used in Atom's release notes.
+  
+
+  
+If this change is not user-facing or notable enough to be included in release notes
+  
+you may use the strings "Not applicable" or "N/A" here.
+  
+
+  
+Examples:
+  
+
+  
+- The GitHub package now allows you to add co-authors to commits.
+  
+- Fixed an issue where multiple cursors did not work in a file with a single line.
+  
+- Increased the performance of searching and replacing across a whole project.
+  
+
+  
+-->