docs: Checklist for compatibility concerns

endojs · Jan 23, 2024 · 039fce5 · 039fce5
1 parent 4fa8e9e
commit 039fce5
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 6 deletions.
diff --git a/.github/ISSUE_TEMPLATE/work_item.md b/.github/ISSUE_TEMPLATE/work_item.md
@@ -13,10 +13,10 @@ assignees: ''
 
 ## Security Considerations
 
-## Compatibility Considerations
-
 ## Scaling Considerations
 
 ## Test Plan
 
+## Compatibility Considerations
+
 ## Upgrade Considerations
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -15,10 +15,6 @@ refs: #XXXX
 
 <!-- Does this change introduce new assumptions or dependencies that, if violated, could introduce security vulnerabilities? How does this PR change the boundaries between mutually-suspicious components? What new authorities are introduced by this change, perhaps by new API calls?  -->
 
-### Compatibility Considerations
-
-<!-- Does this change break any prior usage patterns? Does this change allow usage patterns to evolve? -->
-
 ### Scaling Considerations
 
 <!-- Does this change require or encourage significant increase in consumption of CPU cycles, RAM, on-chain storage, message exchanges, or other scarce resources? If so, can that be prevented or mitigated? -->
@@ -31,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.