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

Conversation

Brijeshthummar02
Copy link
Contributor

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

  • 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)

@MicahGale MicahGale added the documentation Improvements or additions to documentation label Nov 14, 2024
@MicahGale MicahGale self-requested a review November 14, 2024 13:37
@MicahGale MicahGale self-assigned this Nov 14, 2024
Copy link
Collaborator

@MicahGale MicahGale left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

.github/pull_request_template.md Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
@MicahGale
Copy link
Collaborator

@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.

Copy link
Collaborator

@MicahGale MicahGale left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for making these changes. This is looking pretty good. I am happy with merging this as is, and making small tweaks later. Let me know if you want to make the changes I suggested or if you want me to merge this as is.

.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@MicahGale MicahGale left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks for the contribution @Brijeshthummar02

@MicahGale
Copy link
Collaborator

I'm going to override the doc-build failure. It looks like LANL's website is down for now. If they changed their website again that's a different issue.

@MicahGale MicahGale merged commit 7f32ddd into idaholab:develop Nov 23, 2024
22 of 23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update pull request checklist
2 participants