docs: update PULL_REQUEST_TEMPLATE.md

MichaelCurrin commented 3 years ago

Note that there is no need to escape as #\<GitHub-issue-number\> if you use underscores instead of dashes.

e.g.

Fixes #<GITHUB_ISSUE_NUMBER>.

Fixes #.

Though, \<Description of and rationale behind this PR\> needs escaping or it will disappear. I made it italics instead.

nwf commented 2 years ago

Seems OK by me; can we preview the new template somehow?

MichaelCurrin commented 2 years ago

Sure.

Here is it rendered after I copied unaltered from markdown raw code on the branch

Fixes #.

Make sure all boxes are checked (add x inside the brackets) when you submit your contribution, remove this sentence before doing so.

[ ] This PR is for the dev branch rather than for the release branch.
[ ] This PR is compliant with the other contributing guidelines as well (if not, please describe why).
[ ] I have thoroughly tested my contribution.
[ ] The code changes are reflected in the documentation at docs/*.

To be completed below: Description of and rationale behind this PR.

MichaelCurrin commented 2 years ago

nodemcu / nodemcu-firmware