docs: Reminders for compatibility concerns (merge #1992)

endojs · Jan 23, 2024 · 7a21971 · 7a21971
2 parents 004eff5 + 039fce5
commit 7a21971
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE/work_item.md b/.github/ISSUE_TEMPLATE/work_item.md
@@ -17,4 +17,6 @@ assignees: ''
 
 ## Test Plan
 
+## Compatibility Considerations
+
 ## Upgrade Considerations
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -27,6 +27,13 @@ refs: #XXXX
 
 <!-- Every PR should of course come with tests of its own functionality. What additional tests are still needed beyond those unit tests? How does this affect CI, other test automation, or the testnet?  -->
 
+### Compatibility Considerations
+
+<!-- Does this change break any prior usage patterns? Does this change allow usage patterns to evolve? -->
+
 ### Upgrade Considerations
 
 <!-- What aspects of this PR are relevant to upgrading live production systems, and how should they be addressed? -->
+
+- [ ] Includes `*BREAKING*:` in the commit message with migration instructions for any breaking change.
+- [ ] Updates `NEWS.md` for user-facing changes.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -17,4 +17,6 @@ assignees: ''

		## Test Plan

		## Compatibility Considerations

		## Upgrade Considerations