From a9276a3f53ba9726063212f8cc33d652b56cbc52 Mon Sep 17 00:00:00 2001 From: Brijeshthummar02 Date: Thu, 14 Nov 2024 14:37:28 +0530 Subject: [PATCH 1/3] Updated Pull Request Checklist --- .github/pull_request_template.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 34bc845b..7abd246f 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,20 +1,22 @@ # Description -Please include a summary of the change and which issue is fixed if applicable. Please also include relevant motivation and context. +Please include a summary of the change and which issue is fixed, if applicable. Please also include relevant motivation and context. Fixes # (issue) # Checklist -- [ ] I have performed a self-review of my own code -- [ ] I have made corresponding changes to the documentation (if applicable) -- [ ] I have added tests that prove my fix is effective or that my feature works (if applicable) +- [ ] I have performed a self-review of my own code. +- [ ] The code follows the standards outlined in the [development documentation](https://idaholab.github.io/MontePy/developing.html). +- [ ] I have made corresponding changes to the documentation, providing clear details on the added or modified functionality (if applicable). +- [ ] I have added tests that prove my fix is effective or that my feature works (if applicable). +- [ ] I have checked that my code achieves the required test coverage, and I have included coverage reports (if applicable). +# Pull Request Checklist for MontePy -# Description +### Description -Please include a summary of the change and which issue is fixed, if applicable. Please also include relevant motivation and context. +Please provide a summary of the change, referencing the issue it fixes, if applicable. Include relevant context and motivation. -Fixes # (issue) +**Fixes # (issue number)** -# Checklist +--- + +### General Checklist - [ ] I have performed a self-review of my own code. - [ ] The code follows the standards outlined in the [development documentation](https://idaholab.github.io/MontePy/developing.html). -- [ ] I have made corresponding changes to the documentation, providing clear details on the added or modified functionality (if applicable). - [ ] I have added tests that prove my fix is effective or that my feature works (if applicable). - [ ] I have checked that my code achieves the required test coverage, and I have included coverage reports (if applicable). - +- [ ] I have made corresponding changes to the documentation, providing clear details on the added or modified functionality (if applicable). + +--- + +### Documentation Checklist + +- [ ] I have documented all added classes and methods. +- [ ] For infrastructure updates, I have updated the developer's guide. +- [ ] For significant new features, I have added a section to the getting started guide. +- [ ] A link to the Coveralls report is included for reference: [Coveralls](https://coveralls.io/github/idaholab/MontePy/) + +--- + +### Additional Notes for Reviewers + +Ensure that: + +- The submitted code is consistent with the merge checklist outlined [here](https://www.montepy.org/developing.html#merge-checklist). +- The tests pass locally before CI checks. +- The PR covers all relevant aspects according to the development guidelines. +""" From 192a85fa2b09960ea57d19826b323379b3862185 Mon Sep 17 00:00:00 2001 From: Brijeshthummar02 Date: Sat, 23 Nov 2024 09:11:29 +0530 Subject: [PATCH 3/3] Update PR checklist to remove coverage report reference --- .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 57bec802..2e4bb9b4 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -13,7 +13,6 @@ Please provide a summary of the change, referencing the issue it fixes, if appli - [ ] I have performed a self-review of my own code. - [ ] The code follows the standards outlined in the [development documentation](https://idaholab.github.io/MontePy/developing.html). - [ ] I have added tests that prove my fix is effective or that my feature works (if applicable). -- [ ] I have checked that my code achieves the required test coverage, and I have included coverage reports (if applicable). - [ ] I have made corresponding changes to the documentation, providing clear details on the added or modified functionality (if applicable). --- @@ -23,7 +22,12 @@ Please provide a summary of the change, referencing the issue it fixes, if appli - [ ] I have documented all added classes and methods. - [ ] For infrastructure updates, I have updated the developer's guide. - [ ] For significant new features, I have added a section to the getting started guide. -- [ ] A link to the Coveralls report is included for reference: [Coveralls](https://coveralls.io/github/idaholab/MontePy/) + +--- + +### First-Time Contributor Checklist + +- [ ] If this is your first contribution, add yourself to `pyproject.toml` if you wish to do so. ---