-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #592 from Brijeshthummar02/pull-req
Updated Pull Request Checklist
- Loading branch information
Showing
1 changed file
with
36 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). | ||
- [ ] 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. | ||
""" |