github: add a Pull Request template

[minijackson]

This is intended to serve as a reminder for contributors, and hopefully should help keeping the documentation and release notes up-to-date.

This should also save time for reviewers by automatically asking common questions to contributors.

I've only included some common generic questions in the checklist. The PR template doesn't start with a title because GitHub automatically prepend the PR template with the commit message body (so the title would be after that).

[shroffk]

Ah... nice
do you think there is a thinner version of the template?

But overall a decent addition

[ralphlange]

Thinner than 23 lines? Then the line to no template at all gets fuzzy...

I like this, especially the intention to work as a reminder to what PRs should have. (Will copy this for other projects!)

[georgweiss]

In regards to testing...
Is "automated tests" synonymous with unit test code?
Not sure how to use "Tests were run". Assuming all code changes are always verified by developers, this is always "true", right?

As for release notes: not sure how we maintain those.

[shroffk]

Is "automated tests" synonymous with unit test code?

I think we are referring to unit tests ( integration tests are even better but expecting that for all PRs might be overkill )

Not sure how to use "Tests were run". Assuming all code changes are always verified by developers, this is always "true", right?

which is why I think the 2 questions should be merged

About the release notes, right now we don't have a rigid process... but having this in the template is good

@minijackson do you mind if I merge the 2 questions and we start using this

[minijackson]

I originally meant the 2 questions as:

• "there are automated tests for the given feature I'm touching", which I found important in the case someone implements a new feature
• "I have have tested this feature, in whatever way I considered appropriate"

I wanted to stay as generic as possible, so that the contributor ask themselves how to test their contribution, instead of just running a command that might not be relevant. But I agree the current wording is confusing… @shroffk feel free to edit if you have a better solution.

As for release notes: not sure how we maintain those.

@georgweiss there's the changelog but it doesn't seem to have been updated for the last few releases. I personally think it would be good to revive it, and asking the contributor to do it is (in my opinion) a good way of not forgetting things.

[georgweiss]

Agree that the template should indicate whether unit tests and/or integration tests have been added.

[shroffk]

I am going to merge this.. since it is a very useful addition
We can tweak it as we go along