Skip to content

Docs: Add a pull request template#1239

Merged
tyrasd merged 9 commits intoopenstreetmap:mainfrom
tordans:patch-9
Aug 7, 2024
Merged

Docs: Add a pull request template#1239
tyrasd merged 9 commits intoopenstreetmap:mainfrom
tordans:patch-9

Conversation

@tordans
Copy link
Copy Markdown
Collaborator

@tordans tordans commented May 26, 2024

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

@github-actions

This comment was marked as off-topic.

@qugebert

This comment was marked as resolved.

@tordans

This comment was marked as resolved.

tyrasd

This comment was marked as resolved.

@tyrasd tyrasd dismissed their stale review May 31, 2024 08:51

was just a test

tyrasd
tyrasd previously approved these changes May 31, 2024
Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated
@tordans tordans changed the title Add a pull request template Docs: Add a pull request template Jul 11, 2024
tordans added 3 commits July 11, 2024 06:46
It is now hidden by default to keep the initial message clean
@tordans

This comment was marked as outdated.

@tordans tordans requested a review from tyrasd July 11, 2024 04:57
@tordans
Copy link
Copy Markdown
Collaborator Author

tordans commented Jul 11, 2024

@tyrasd this is ready to be merged from my point of view. It will make new PRs a lot easier to review…
I will iterate on it if needed once we learn how people use / understand it.

@Asteliks
Copy link
Copy Markdown
Contributor

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

@tordans
Copy link
Copy Markdown
Collaborator Author

tordans commented Jul 13, 2024

Personally, I prefer the description to be in an issue and not duplicated,

Agreed. However I would assume people are lazy and will just leave this part blank or reference the issue for the first section.
While reviewing the PRs recently I found that the issue did not really help a lot, which is why I ask for more context here.
The issues are sometimes created by users that only know the wiki link of a tag but don't know how to do more research on it. My goal for the PR is to ask people to do this research now …

I think we can see how it goes with this one and modify if needed.

@Asteliks
Copy link
Copy Markdown
Contributor

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

Copy link
Copy Markdown
Member

@tyrasd tyrasd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@tyrasd tyrasd merged commit e8249e2 into openstreetmap:main Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants