Docs: Add a pull request template#1239
Conversation
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
It is now hidden by default to keep the initial message clean
This comment was marked as outdated.
This comment was marked as outdated.
|
@tyrasd this is ready to be merged from my point of view. It will make new PRs a lot easier to review… |
|
Personally, I prefer the description to be in an issue and not duplicated, but I know that this will be annoying for the contributors and maintainers (these groups usually make PRs without issues). As such, my recommendation is that this template should only be used when there isn't an issue linked to the PR |
Agreed. However I would assume people are lazy and will just leave this part blank or reference the issue for the first section. I think we can see how it goes with this one and modify if needed. |
I fully agree let's see how it will work in the wiled |
tyrasd
left a comment
There was a problem hiding this comment.
For a lot of PRs it will not be necessary and perhaps could even be borderline a waste of time to send screenshots, etc.… Hopefully contributors are not deterred by that.
But let's try it anyway and see whether this makes the maintenance work a little bit easier.
We can use a pull request template to nudge contributors to add information to the PRs that make it easier to review them.
This template is based on https://github.com/twbs/bootstrap/blob/main/.github/PULL_REQUEST_TEMPLATE.md?plain=1 but change to fit the tagging schema.
My idea is, to nudge contributors to first add more context to PRs like links. But then after the preview was generated, to get back , edit the description and add more links and screenshots that make it super fast to review the PRs.
Here are the docs on adding those templates. In general they are much less fancy than the issue templates, so it's just a Markdown template.
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository