Add a pull request template to the xwiki-platform Github

Development
5

I agree with the changes you proposed, except for the removal of the Notes section. The main question answered in those two sections are different:

  • Description of changes answers What is changed ?
  • Notes answers Why is it changed like that ?

The title Notes does not really explain any of it but I did not really question it so far. Maybe Clarifications or Explanations would be better suited.

The * Expected backporting/cherry-picking strategy part in here does not fit with the above question. I think it’d be best to move it to a new section.

Here is the updated template proposal:

# Jira URL
<!--- Always put a JIRA issue reference in a commit message --->

# Changes
## Description
<!--- Describe the main changes brought in this PR. --->
*
## Clarifications
<!--- Provide extra hints to make it easier to understand the PR. Those could be:
* Explanation of choices made in this PR
* Anchor towards extra resources needed to understand the context of this PR. E.g. a proposal on the forum.
--->
*
# Screenshots & Video
<!--- If this PR introduces any UI change, it's recommended to highlight it with before/after screenshots or even a screen recording for complex interactions. --->

# Executed Tests
<!--- Especially important for regression fixes. 
Indicate how changes were tested, e.g. what maven commands were run to validate them.
--->
# Expected merging strategy
* Prefers squash: Yes / No
* Backport on branches:
  *

visuals of the above template in Github dark theme

I think it looks sharper, thanks a lot for the vocabulary changes propositions :slight_smile: