chore: improve PR template text

[nbbeeken]

Improve PR template text

What is changing?

The PR template description in order to add helpful information and easy reference to important guides.

What is the motivation for this change?

It helps keep us organized, and double checks our essentials before publishing a PR.

Double check the following

• Ran npm run check:lint script
• Completed self-review using the steps outlined here
• PR title follows the correct format: <type>(NODE-xxxx)<!>: <description>
• Changes sufficiently covered by new or existing tests
  • n/a, markdown changes only
• New TODOs have a related JIRA ticket
  • n/a, none

[dariakp]

Just a couple thoughts on phrasing here

[kmahar]

is it worth noting that this section and the next only apply to bug fix PRs?

For feature PRs it might be worth asking about like the use case for the feature or something like that, to help us evaluate the value of it

[nbbeeken]

I looked into what I mentioned during our meeting about a button that differentiates the text based on a type. And that appears to be for Issues and not PRs. Maybe we drop these to headers. and just stick with #### What is the motivation for this change?

[dariakp]

I think that's reasonable, I think we could also put in the commented text something along the lines of "if filing a bug, please describe the current/desired behavior"

[nbbeeken]

Published changes after I commented so now it has comments like so:

#### What is the motivation for this change?

<!-- If this is a bug, it helps to describe the current behavior and a clear outline of the expected behavior -->
<!-- If this is a feature, it helps to describe the new use case enabled by this change -->