Skip to content

Commit 4e8773c

Browse files
MichaelChiricofelicitymaynguyenalex836
authored
Be sure to define 'description' (#35804)
Co-authored-by: Felicity Chapman <felicitymay@github.com> Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com>
1 parent a494a7b commit 4e8773c

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

content/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,16 @@ topics:
1919
shortTitle: Link PR to issue
2020
---
2121

22-
> [!NOTE]
23-
> 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.**
24-
2522
## About linked issues and pull requests
2623

27-
You can link an issue to a pull request manually or using a supported keyword in the pull request description.
24+
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.
2825

2926
When you link a pull request to the issue the pull request addresses, collaborators can see that someone is working on the issue.
3027

31-
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).
28+
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).
29+
30+
> [!NOTE]
31+
> 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.
3232
3333
## Linking a pull request to an issue using a keyword
3434

0 commit comments

Comments
 (0)