Skip to content
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

Jump to bottom

Update linking-a-pull-request-to-an-issue.md #199

Merged
merged 6 commits into from
Oct 15, 2020
Merged

Update linking-a-pull-request-to-an-issue.md #199

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
66f835f
Update linking-a-pull-request-to-an-issue.md
casals Oct 7, 2020
457e266
Update linking-a-pull-request-to-an-issue.md
casals Oct 8, 2020
76e2503
Merge branch 'main' into patch-10
myarb Oct 13, 2020
18b6e8e
Update linking-a-pull-request-to-an-issue.md
casals Oct 15, 2020
037a22b
Update content/github/managing-your-work-on-github/linking-a-pull-req…
casals Oct 15, 2020
bc47f60
Merge branch 'main' into patch-10
felicitymay Oct 15, 2020
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: 8 additions & 2 deletions content/github/managing-your-work-on-github/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 @@ -11,9 +11,15 @@ versions:
enterprise-server: '*'
---

{% note %}

**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.**

{% endnote %}

### About linked issues and pull requests

You can link an issue to a pull request {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}manually or {% endif %}using a supported keyword in the pull request description.
You can link an issue to a pull request {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}manually or {% endif %}using a supported keyword in the pull request description.

When you link a pull request to the issue the pull request addresses, collaborators can see that someone is working on the issue. {% if currentVersion ver_lt "[email protected]" %}If the pull request and the issue are in different repositories, {% data variables.product.product_name %} will display the link after the pull request is merged, if the person who merges the pull request also has permission to close the issue.{% endif %}

Expand All @@ -37,7 +43,7 @@ You can manually link up to ten issues to each pull request. The issue and pull

### Linking a pull request to an issue using a keyword

You can link a pull request to an issue by using a supported keyword in the pull request's description.
You can link a pull request to an issue by using a supported keyword in the pull request's description or in a commit message (please note that the pull request must be on the default branch).

* close
* closes
Expand Down