From e605d8007cd97196dc3a14a38fdfd82315900477 Mon Sep 17 00:00:00 2001
From: Antoine Stevan <44101798+amtoine@users.noreply.github.com>
Date: Sat, 10 Jun 2023 17:10:03 +0200
Subject: [PATCH] add a comment note to the PR template about linking issues
 (#9392)

i see very often contributors mentionning an issue that their PR is
supposed to solve without using the proper [*linking keywords* of
*GitHub*](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
:thinking:

in this PR, i've added a little comment to the top of the PR template to
hopefully explain how to achieve this automatically without requiring
maintainers to link PRs manually :relieved:
---
 .github/pull_request_template.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 11ab0de333..9be2625aab 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,3 +1,11 @@
+<!--
+if this PR closes one or more issues, you can automatically link the PR with
+them by using one of the [*linking keywords*](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword), e.g.
+- this PR should close #xxxx
+- fixes #xxxx
+
+you can also mention related issues, PRs or discussions!
+-->
 
 # Description
 <!--