From e03485c81303f35c1fa2730d28083c3d5e93777f Mon Sep 17 00:00:00 2001 From: Nada Date: Mon, 18 Dec 2023 18:22:27 +0100 Subject: [PATCH 1/2] Add pull request template --- .github/pull_request_template.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..f4e2f847 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,23 @@ +## Summary + +> Developers should provide a summary of the proposed changes here and include "closes #" if this addresses an open issue. +> Developers should include validation test reports demonstrating that the reported errors have been solved. + +## Reviewer Checklist + +> Reviewers should tick the following boxes before approving and merging the PR. + +- [ ] The PR targets the `develop` branch +- [ ] The PR is assigned to the developer +- [ ] The PR has appropriate labels +- [ ] The PR is included in appropriate projects and/or milestones +- [ ] The PR includes a clear description of the proposed changes +- [ ] If the PR addresses an open issue the description includes "closes #" +- [ ] The code and documentation style match the current standards +- [ ] Documentation has been added/updated consistently with the code +- [ ] All CI tests are passing +- [ ] API docs have been built and checked at least once (if relevant) +- [ ] All changed files have been checked and comments provided to the developer +- [ ] All of the reviewer's comments have been satisfactorily addressed by the developer +- [ ] All Validation tests for the reported error are passing + From 1c340ea563c682606e8ef98ab7d9adf7fc35f852 Mon Sep 17 00:00:00 2001 From: Nada Date: Wed, 3 Jan 2024 13:28:26 +0100 Subject: [PATCH 2/2] made changes to the template --- .github/pull_request_template.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index f4e2f847..af4136c2 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,7 +1,12 @@ ## Summary > Developers should provide a summary of the proposed changes here and include "closes #" if this addresses an open issue. -> Developers should include validation test reports demonstrating that the reported errors have been solved. + +## Validation Test Reports + +> Developers should include training and metrics validation test reports demonstrating that all tests passed. + +(Copy and paste the output of validation tests report here in markdown.) ## Reviewer Checklist @@ -20,4 +25,3 @@ - [ ] All changed files have been checked and comments provided to the developer - [ ] All of the reviewer's comments have been satisfactorily addressed by the developer - [ ] All Validation tests for the reported error are passing -