Skip to content

Commit

Permalink
Add PR checklist template for consistency and standards
Browse files Browse the repository at this point in the history
  • Loading branch information
Brijeshthummar02 committed Nov 22, 2024
1 parent a9276a3 commit 1623de8
Showing 1 changed file with 28 additions and 14 deletions.
42 changes: 28 additions & 14 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,37 @@
<!--
If you are a first-time contributor to MontePy,
refer to the developing guidelines at:
https://idaholab.github.io/MontePy/developing.html
-->
# 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).
<!--
While tests will automatically be checked by CI, it is good practice to
ensure that they pass locally first.
-->
- [ ] 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.
"""

0 comments on commit 1623de8

Please sign in to comment.