From 54e245601889568c17815a701a52f40c54dc31de Mon Sep 17 00:00:00 2001 From: Arash M <27716912+am357@users.noreply.github.com> Date: Tue, 28 Jun 2022 13:26:09 -0700 Subject: [PATCH 1/3] Add backward-compatiblity and dependency questions to PR template Updating the tempalate so we can have more context on the included backward incompatible and dependency changes in the PRs. --- .github/PULL_REQUEST_TEMPLATE.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 91291cc8e0..0a6574ba17 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,6 +2,17 @@ *Description of changes:* -*Have you updated the `Unreleased` section of `CHANGELOG.md` with your changes? (y/n) If not, please explain why:* +*Have you updated the `Unreleased` section of `CHANGELOG.md` with your changes? (y/n), If not, please explain why:* + +*Does your PR include any backward-incompatible changes? (y/n), if yes, why? and what other alternatives you've + considered and why they've been discarded?:* + +``` +For this purpose, we define backward-incompatible changes as changes that—when consumed—can potentially result in +errors for users that are using our public APIs or the entities that have `public` visibility in our code-base. +``` + +*Does your PR introduces a new external dependency? (y/n), if yes, why? and what other alternatives you've +considered and why they've been discarded?:* By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. From 8c1f2ef25250e0623e85e74801260b5bdbf4be18 Mon Sep 17 00:00:00 2001 From: Arash M <27716912+am357@users.noreply.github.com> Date: Tue, 28 Jun 2022 13:38:55 -0700 Subject: [PATCH 2/3] Add unreleased changes --- .github/PULL_REQUEST_TEMPLATE.md | 8 ++++---- CHANGELOG.md | 5 +++++ 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0a6574ba17..baa6c70e99 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,15 +4,15 @@ *Have you updated the `Unreleased` section of `CHANGELOG.md` with your changes? (y/n), If not, please explain why:* -*Does your PR include any backward-incompatible changes? (y/n), if yes, why? and what other alternatives you've - considered and why they've been discarded?:* +*Does your PR include any backward-incompatible changes? (y/n), if yes, please explain the reason. In addition, please + also mention any other alternatives you've considered and the reason they've been discarded?:* ``` For this purpose, we define backward-incompatible changes as changes that—when consumed—can potentially result in errors for users that are using our public APIs or the entities that have `public` visibility in our code-base. ``` -*Does your PR introduces a new external dependency? (y/n), if yes, why? and what other alternatives you've -considered and why they've been discarded?:* +*Does your PR introduces a new external dependency? (y/n), if yes, please explain the reason. In addition, please +also mention any other alternatives you've considered and the reason they've been discarded?:* By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. diff --git a/CHANGELOG.md b/CHANGELOG.md index b9ce3e9b48..eda5c56fcb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] ### Added +- `CHANGELOG.md` with back-filling of the previous releases to the change log to provide more visibility on unreleased + changes and make the release process easier by using the `unreleased` section of change log. The `CONTRIBUTING.md` + has also been updated to ensure this is part of the process. +- backward-incompatiblity and dependency questions are added to the project's PR process to provide more context + on the changes that include these and the alternatives that have been considered. ### Changed From 7a65912895d1336352aeba9eb3359129b8912777 Mon Sep 17 00:00:00 2001 From: Arash Maymandi <27716912+am357@users.noreply.github.com> Date: Tue, 28 Jun 2022 14:00:43 -0700 Subject: [PATCH 3/3] Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Alan Cai --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index baa6c70e99..cf3d70b197 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -12,7 +12,7 @@ For this purpose, we define backward-incompatible changes as changes that—when errors for users that are using our public APIs or the entities that have `public` visibility in our code-base. ``` -*Does your PR introduces a new external dependency? (y/n), if yes, please explain the reason. In addition, please +*Does your PR introduce a new external dependency? (y/n), if yes, please explain the reason. In addition, please also mention any other alternatives you've considered and the reason they've been discarded?:* By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.