tools: Update Github pull request template

[orpheuslummis]

RELEVANT ISSUE(S)

Resolves #523

DESCRIPTION

Update pull request template with the following goals:

• simplification and clarity
• making sure the PR author checks all the boxes
• nudging the PR author to discuss limitations

Starting as a draft PR for the purpose of reaching an happy consensus.

HOW HAS THIS BEEN TESTED?

Not applicable.

CHECKLIST:

• I have commented the code, particularly in hard-to-understand areas.
• I have made corresponding changes to the repo-held documentation.
• I have made sure that the PR title adheres to the conventional commit style (subset of the ones we use can be found under: tools/configs/chglog/config.yml

ENVIRONMENT / OS THIS WAS TESTED ON?

Please specify which of the following was this tested on (remove or add your own):

• Arch Linux
• Debian Linux
• MacOS
• Windows

[orpheuslummis]

Its possible to preview the Markdown file directly at https://github.com/sourcenetwork/defradb/blob/09cc121cacbeb422fe678a7ce3f17cb0dc118598/.github/pull_request_template.md

[orpheuslummis]

In the suggested template, do you you think you would usually check all boxes ?

[shahzadlone]

In the suggested template, do you you think you would usually check all boxes ?

Most likely not, because I don't always have to update the repo held documentation for example. Unless maybe the wording was like if applicable, you updated repo held docs.....
Not sure if we want to go that route though.

[AndrewSisley]

In the suggested template, do you you think you would usually check all boxes ?

I usually do, e.g. even if I think the code requires no comments, I see the code as properly documented and tick it off. The number of done/todo tasks are visible at the top of the PR and is a very good way of telling if there is anything left outstanding (the OS boxes mess with this a bit, and I dont like them, but as long as there are only 3 remaining tasks on a PR then I will merge after approval)

[orpheuslummis]

In the suggested template, do you you think you would usually check all boxes ?

Most likely not, because I don't always have to update the repo held documentation for example. Unless maybe the wording was like if applicable, you updated repo held docs..... Not sure if we want to go that route though.

I think it'd be important, somehow, for PR authors to be lead into "checking all the tasks/boxes"