From 6d66aae081437bec47386593c2615a6ed28b5ccd Mon Sep 17 00:00:00 2001 From: Matias Piipari Date: Thu, 18 Apr 2024 17:08:07 +0300 Subject: [PATCH 1/2] Update pull request template with steps to follow for file format changes (Infra) --- .github/pull_request_template.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 88d265cd6d..c377f46e22 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -29,6 +29,7 @@ Describe your changes here: - What's the problem solved (briefly, since the issue is where this is elaborated in more detail). - Introduce your implementation approach in a way that helps reviewing it well. +- Alert the reviewer of any changes that involve data persistence: present examples of file format changes as part of the PR description (e.g. new fields of data stored in unit or submission output). --> ## Resolved issues @@ -46,6 +47,7 @@ Please make sure that... - Documentation in the repository, including contribution guidelines. - Process documentation outside the repository. - Tests are included for the changed functionality in this PR. If to be merged without tests, please elaborate why. +- When breaking changes and other key changes are introduced, the PR having been merged should be broadcast (in demo sessions, IM, Discourse) with relevant references to documentation. This is an opportunity to gather feedback and confirm that the changes and how they are documentated are understood. --> ## Tests @@ -55,4 +57,3 @@ Please make sure that... - Please provide a list of what tests were run and on what platform/configuration. - Remember to check the test coverage of your PR as described in CONTRIBUTING.md --> - From 5d05ba52899094e93e70c2a5c4b4cdd381af24e8 Mon Sep 17 00:00:00 2001 From: Matias Piipari Date: Thu, 18 Apr 2024 17:34:10 +0300 Subject: [PATCH 2/2] Update .github/pull_request_template.md Co-authored-by: kissiel --- .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 c377f46e22..711375f216 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -47,7 +47,7 @@ Please make sure that... - Documentation in the repository, including contribution guidelines. - Process documentation outside the repository. - Tests are included for the changed functionality in this PR. If to be merged without tests, please elaborate why. -- When breaking changes and other key changes are introduced, the PR having been merged should be broadcast (in demo sessions, IM, Discourse) with relevant references to documentation. This is an opportunity to gather feedback and confirm that the changes and how they are documentated are understood. +- When breaking changes and other key changes are introduced, the PR having been merged should be broadcast (in demo sessions, IM, Discourse) with relevant references to documentation. This is an opportunity to gather feedback and confirm that the changes and how they are documented are understood. --> ## Tests