Updated Pull Request Checklist #592
Conversation
There was a problem hiding this comment.
Thank you @Brijeshthummar02 for tackling this.
For some context, I am the main contributor and usually opening most of the PRs myself, and I feel like I have been getting a little bit lazy with this. This issue was mostly a quick note I mostly wrote to myself to update the checklist so I get less lazy with my PRs. So sorry that there was some ambiguity in the issue.
If you would like to make more contributions we have a tag for issues that might be easier to start with: good first issue. Out of curiosity: how did you come across MontePy? It is a bit of a niche library.
| - [ ] 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). |
There was a problem hiding this comment.
I don't think this alone adds much value, as the guidelines are already linked.
I would say remove this line and then go through the checklist here, and make sure everything is coverered: https://www.montepy.org/developing.html#merge-checklist
| - [ ] 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). |
There was a problem hiding this comment.
I was thinking this would have some sub bullet points:
- [ ] 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.
| - [ ] 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). |
There was a problem hiding this comment.
I'm realizing this is hacky solution right now. I am working to debug why coveralls isn't sending status updates.
I just want the merger (usually me) to add a link to the coveralls report. A link to coveralls: https://coveralls.io/github/idaholab/MontePy/ should be included to be able to quickly get there.
|
@Brijeshthummar02 I wanted to check on this. Are you able to make these changes? If I don't hear back in a week I will close this PR. |
Description
here’s an improved version of your .md checklist file with added sections for documentation standards, details on expected documentation, and coverage reports.
Fixes #591
Checklist