From 4fa8e9e950b507eda680905bacb9409cbe73a345 Mon Sep 17 00:00:00 2001 From: Kris Kowal Date: Mon, 22 Jan 2024 10:58:06 -0800 Subject: [PATCH 1/2] docs: Add compatibility considerations to issue and change templates --- .github/ISSUE_TEMPLATE/work_item.md | 2 ++ .github/PULL_REQUEST_TEMPLATE.md | 4 ++++ 2 files changed, 6 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/work_item.md b/.github/ISSUE_TEMPLATE/work_item.md index 8330f2770b..f5a91fb086 100644 --- a/.github/ISSUE_TEMPLATE/work_item.md +++ b/.github/ISSUE_TEMPLATE/work_item.md @@ -13,6 +13,8 @@ assignees: '' ## Security Considerations +## Compatibility Considerations + ## Scaling Considerations ## Test Plan diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index dfd1094c8d..92c4128b59 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -15,6 +15,10 @@ refs: #XXXX +### Compatibility Considerations + + + ### Scaling Considerations From 039fce5fc1c6eb5388bed113e717b05915ff6763 Mon Sep 17 00:00:00 2001 From: Kris Kowal Date: Mon, 22 Jan 2024 11:05:49 -0800 Subject: [PATCH 2/2] docs: Checklist for compatibility concerns --- .github/ISSUE_TEMPLATE/work_item.md | 4 ++-- .github/PULL_REQUEST_TEMPLATE.md | 11 +++++++---- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/work_item.md b/.github/ISSUE_TEMPLATE/work_item.md index f5a91fb086..e1f13c42ce 100644 --- 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 index 92c4128b59..5325b35ef4 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -15,10 +15,6 @@ refs: #XXXX -### Compatibility Considerations - - - ### Scaling Considerations @@ -31,6 +27,13 @@ refs: #XXXX +### Compatibility Considerations + + + ### Upgrade Considerations + +- [ ] Includes `*BREAKING*:` in the commit message with migration instructions for any breaking change. +- [ ] Updates `NEWS.md` for user-facing changes.