Skip to content

Commit 98c402e

Browse files
authored
Merge pull request #199 from casals/patch-10
Update linking-a-pull-request-to-an-issue.md
2 parents af7e3e8 + bc47f60 commit 98c402e

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

content/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,15 @@ versions:
1111
enterprise-server: '*'
1212
---
1313

14+
{% note %}
15+
16+
**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.**
17+
18+
{% endnote %}
19+
1420
### About linked issues and pull requests
1521

16-
You can link an issue to a pull request {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}manually or {% endif %}using a supported keyword in the pull request description.
22+
You can link an issue to a pull request {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}manually or {% endif %}using a supported keyword in the pull request description.
1723

1824
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 "enterprise-server@2.21" %}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 %}
1925

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

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

40-
You can link a pull request to an issue by using a supported keyword in the pull request's description.
46+
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).
4147

4248
* close
4349
* closes

0 commit comments

Comments
 (0)