From 90b20a502f263f47082e649deb0b0253953d4075 Mon Sep 17 00:00:00 2001 From: George Date: Tue, 11 Nov 2025 16:48:59 +0100 Subject: [PATCH] Adding a note for linking a PR to an issue via a keyword --- asciidoc/github_workflow_best_practices.adoc | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/asciidoc/github_workflow_best_practices.adoc b/asciidoc/github_workflow_best_practices.adoc index f5ed48f1..9efff3e8 100644 --- a/asciidoc/github_workflow_best_practices.adoc +++ b/asciidoc/github_workflow_best_practices.adoc @@ -246,4 +246,9 @@ This will open an editor where you can squash, fixup, reword, etc., commits $ git push --force-with-lease origin myawesomebranch ---- -NOTE: See https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History[the official Git documentation for more information] +[NOTE] +==== +See https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History[the official Git documentation for more information] + +If you're trying to fix a Github issue, don't forget to link the PR to an issue by adding "Closes #XXX" or "Fixes #XXX" to the commit message. See https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword[Linking a pull request to an issue using a keyword] for more information about this feature. +====