Update PULL_REQUEST_TEMPLATE.md

glemieux commented 1 year ago

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:

[x] My change requires a change to the documentation.
[x] I have updated the in-code documentation .AND. (the technical note .OR. the wiki) accordingly.
[x] 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:

glemieux commented 1 year ago

Referencing comment for posterity since I meant to write it here initially: https://github.com/NGEET/fates/pull/1070#issuecomment-1692521103

rgknox commented 1 year ago

@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 commented 1 year ago

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

NGEET / fates