setup default PR templates

[bplessis-swi]

First attempt to propose a generic default PR description template for the org
Any input appreciated

[cthirouin-swi]

My 2 cents:
It's nice on paper but I doubt most of the users will fill it all on each PR. In instance, av-backend repo has a PR template and it's rarely used.
I'd rather by pragmatic and have a sort of minimum viable PR template which would include:

• a link to the Jira item
• a short description of the technical modifications made
• (optional) a longer description to give some technical context to the reviewers
• (optional) actions to be done before merging/deploying

For the other info, I'd rather put them in the Jira item and/or Confluence.

I also think this would be nice to enforce the commit message format (using Conventional Commit in instance). But it's another story.

[bplessis-swi]

My 2 cents: It's nice on paper but I doubt most of the users will fill it all on each PR.

the idea is more to have some base idea to fill in the description, not to enforce everything, and help PR creator, first-timer or not to avoid the "white page syndrom"

for ex part of the template include a checklist of what we should have done outside the PR including documenting correctly the jira issue

I'd rather by pragmatic and have a sort of minimum viable PR template which would include:
we can definitely reduce it yes

I also think this would be nice to enforce the commit message format (using Conventional Commit in instance). But it's another story.

Well ... since the commits are actually squashed in the end not sure this would be really useful

[aservedio-swi]

There are aspects of your template that may be important for some changes, but overkill for others (I don't think it is possible to get a one-size-fits-all for this kind of thing).

Personally, I would greatly simplify this to (this may even be too much as they have to delete it each time, but maybe gives a little more instruction):

PLTFRS-XXX - Short Description of the Change

Please add details to provide the reviewers context about the change. This PR description will also be used as the merge commit and release description - so describe the change so that future developers understand what was done and why.

[cin]

While I like the level of detail included in the template, I think it's overkill for most repos. I could see larger repos requiring more information, but this is really hard to generalize. Some repos may want to focus on testing or visualizations for example. For the general use case, I would just go w/something like Allen suggested.