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

Update PULL_REQUEST_TEMPLATE.md #1069

Merged
merged 4 commits into from
Aug 31, 2023
Merged

Update PULL_REQUEST_TEMPLATE.md #1069

merged 4 commits into from
Aug 31, 2023

Conversation

glemieux
Copy link
Contributor

@glemieux glemieux commented Aug 24, 2023

Description:

Updating the PR template to direct contributors to create an issue on the fates technical and/or user's guide as necessary so that we can track what needs updating.

Resolves #1068

Collaborators:

@ckoven @rgknox

Expectation of Answer Changes:

No, as this is a github template change

Checklist:

  • My change requires a change to the documentation.
  • I have updated the in-code documentation .AND. (the technical note .OR. the wiki) accordingly.
  • I have read the CONTRIBUTING document.
  • FATES PASS/FAIL regression tests were run
  • If answers were expected to change, evaluation was performed and provided

Test Results:

CTSM (or) E3SM (specify which) test hash-tag:

CTSM (or) E3SM (specify which) baseline hash-tag:

FATES baseline hash-tag:

Test Output:

Updating the PR template to direct contributors to create an issue on the fates technical and/or user's guide as necessary so that we can track what needs updating.
@glemieux glemieux requested a review from rgknox August 24, 2023 22:20
@glemieux glemieux added the github updates to .github files typically for configuration or workflow automation label Aug 24, 2023
Adding a subsection for documentation and changing the checklist language
@glemieux
Copy link
Contributor Author

Referencing comment for posterity since I meant to write it here initially: #1070 (comment)

@rgknox
Copy link
Contributor

rgknox commented Aug 30, 2023

@glemieux I love the links to the documentation, great addition. I think the new template is an improvement.

Question, should we split the checklist into things that the author needs to do, and things that either the integrators (us) and/or author+integrators need to do?

@glemieux
Copy link
Contributor Author

@glemieux I love the links to the documentation, great addition. I think the new template is an improvement.

Question, should we split the checklist into things that the author needs to do, and things that either the integrators (us) and/or author+integrators need to do?

That's a good idea.

Note which checklist item is the responsibility of the contributor or the integrator
@glemieux glemieux mentioned this pull request Aug 30, 2023
5 tasks
Copy link
Contributor

@rgknox rgknox left a comment

Choose a reason for hiding this comment

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

Thanks @glemieux

@glemieux glemieux merged commit 73f31ab into main Aug 31, 2023
@glemieux glemieux deleted the glemieux-patch-1 branch September 18, 2023 22:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
github updates to .github files typically for configuration or workflow automation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update the pull request template to prompt user to make an issue for the FATES technical documentation
2 participants