PR Template: Suggest linking the issue

[Mamaduka]

What?

Update the PR template and recommend linking the issue using a reserved keyword.

Why?

Often, PRs aren't linked to their corresponding issue or incorrectly reference them.

Testing Instructions

None.

[github-actions]

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: Mamaduka <mamaduka@git.wordpress.org>
Co-authored-by: stokesman <presstoke@git.wordpress.org>
Co-authored-by: priethor <priethor@git.wordpress.org>
Co-authored-by: afercia <afercia@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

[priethor]

Yes, please, this will help standardize how to provide context to PRs and minimize PRs without issue.

[github-actions]

Flaky tests detected in f61804a.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/13027760486
📝 Reported issues:

• [Flaky Test] Redirection after template creation #60678 in /test/e2e/specs/site-editor/site-editor-url-navigation.spec.js

[afercia]

Love this change.

It should be good to specify in the instructions that linking to an issue is encouraged, although not strictly necessary. There can also be cases where the PR doesn't close an issue but is a "Follow up to #XXXX".

Right, and sometimes it could be a PR that addresses only a part of the issue, pending other incremental PRs, so that it'snot always a 'close'. What about suggesting a few keywords e.g.:

<!-- Link this PR to its associated issue with an appropriate keyword: Closes, See, Follow up to, etc. -->

And maybe link to the list o fkeywords?

linking to an issue is encouraged, although not strictly necessary

The contributing guidelines of this project require any non-trivial PRs to be preceded by an issue to allow discussion. I would love to see this at least mentioned or linked to in the PR template. See: https://github.com/WordPress/gutenberg/blob/trunk/docs/contributors/repository-management.md#pull-requests

Non-trivial pull requests should be preceded by a related issue that defines the problem to solve and allows for discussion of the most appropriate solution before actually writing code.

[Mamaduka]

Thank you, @afercia! I've updated the text to list possible keywords.

The template already links to the contribution guidelines. Since these templates are for new contributors, I don't think we want to overload them with information.

The contributing guidelines of this project require any non-trivial PRs to be preceded by an issue to allow discussion.

While I mostly agree here, defining "non-trivial" PR is complicated. When reviewing PRs, I'll usually comment with a link to the docs when this is the case.

This is also true for PRs with an attached issue, but the solution isn't clear, or adding a feature that might be better suited for a plugin.

[priethor]

The suggestions are clear and varied while still suggesting closing an issue by default. I don't think we should overcomplicate it and ship this as a first step.

[Mamaduka]

Thanks for the input, everyone! 🙇