Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated Pull Request Checklist #592

Merged
merged 3 commits into from
Nov 23, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 36 additions & 16 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,41 @@
<!--
If you are a first-time contributor to MontePy,
refer 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
---

- [ ] 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)
<!--
While tests will automatically be checked by CI, it is good practice to
ensure that they pass locally first.
-->
### 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 added tests that prove my fix is effective or that my feature works (if applicable).
MicahGale marked this conversation as resolved.
Show resolved Hide resolved
- [ ] 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.

---

### First-Time Contributor Checklist

- [ ] If this is your first contribution, add yourself to `pyproject.toml` if you wish to do so.

---

### 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.
"""
Loading