From 76652e8c24232f47c45febdffa2e4240e5743a16 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Tue, 31 Dec 2024 23:24:33 -0800 Subject: [PATCH 1/2] Be sure to define 'description' --- .../using-issues/linking-a-pull-request-to-an-issue.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md b/content/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md index 3c090bd42abb..29047f3a58e4 100644 --- a/content/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md +++ b/content/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md @@ -20,7 +20,7 @@ shortTitle: Link PR to issue --- > [!NOTE] -> The special keywords in a pull request description are interpreted when the pull request targets the repository's _default_ branch. However, if the PR's base is _any other branch_, then these keywords are ignored, no links are created and merging the PR has no effect on the issues. **If you want to link a pull request to an issue using a keyword, the PR must be on the default branch.** +> The special keywords in a pull request description, i.e. the text comment accompanying the title written by the PR author, are interpreted when the pull request targets the repository's _default_ branch. However, if the PR's base is _any other branch_, then these keywords are ignored, no links are created and merging the PR has no effect on the issues. **If you want to link a pull request to an issue using a keyword, the PR must be on the default branch.** ## About linked issues and pull requests From ba3fc5c8e68d4d78252a39039319298a3137f061 Mon Sep 17 00:00:00 2001 From: Felicity Chapman Date: Thu, 2 Jan 2025 12:27:35 +0000 Subject: [PATCH 2/2] Move note and definition of description into first section --- .../using-issues/linking-a-pull-request-to-an-issue.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md b/content/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md index 29047f3a58e4..a11759f859e6 100644 --- a/content/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md +++ b/content/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md @@ -19,16 +19,16 @@ topics: shortTitle: Link PR to issue --- -> [!NOTE] -> The special keywords in a pull request description, i.e. the text comment accompanying the title written by the PR author, are interpreted when the pull request targets the repository's _default_ branch. However, if the PR's base is _any other branch_, then these keywords are ignored, no links are created and merging the PR has no effect on the issues. **If you want to link a pull request to an issue using a keyword, the PR must be on the default branch.** - ## About linked issues and pull requests -You can link an issue to a pull request manually or using a supported keyword in the pull request description. +You can link an issue to a pull request manually or using a supported keyword in the pull request description, that is, the summary text added by the author when they created the pull request. When you link a pull request to the issue the pull request addresses, collaborators can see that someone is working on the issue. -When you merge a linked pull request into the default branch of a repository, its linked issue is automatically closed. For more information about the default branch, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch). +When you merge a linked pull request into the **default branch** of a repository, its linked issue is automatically closed. For more information about the default branch, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch). + +> [!NOTE] +> The special keywords in a pull request description are interpreted only when the pull request targets the repository's _default_ branch. If the pull request targets _any other branch_, then these keywords are ignored, no links are created, and merging the PR has no effect on the issues. ## Linking a pull request to an issue using a keyword