Skip to content

Be sure to define 'description' #35804

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nguyenalex836 merged 3 commits into from
Jan 6, 2025
Merged

Be sure to define 'description' #35804

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
76652e8
Be sure to define 'description'
MichaelChirico Jan 1, 2025
ba3fc5c
Move note and definition of description into first section
felicitymay Jan 2, 2025
6ceaf50
Merge branch 'main' into patch-1
nguyenalex836 Jan 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions ...acking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,16 @@ topics:
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.**

## 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

Expand Down