Skip to content

Commit 5bbf0dc

Browse files
Copilotwadepickett
andauthored
Update PR-linking guidance to prevent cross-repo issues from auto-closing (#37534)
* Initial plan * Update PR-linking guidance to prevent cross-repo issue auto-close Co-authored-by: wadepickett <10985336+wadepickett@users.noreply.github.com> * Use MM/DD/YYYY slash format for ms.date per metadata guidance Co-authored-by: wadepickett <10985336+wadepickett@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: wadepickett <10985336+wadepickett@users.noreply.github.com>
1 parent c1d5ff1 commit 5bbf0dc

2 files changed

Lines changed: 20 additions & 5 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,20 @@
33
<!--
44
# Instructions
55
6-
When creating a new PR, please reference the issue number if there is one:
6+
When creating a new PR, reference the originating issue on the first line of the description:
77
8-
Fixes #Issue_Number
8+
* Issue in this repository (dotnet/AspNetCore.Docs): use a closing keyword so GitHub auto-closes the issue when this PR is merged:
99
10-
The "Fixes #nnn" syntax in the PR description allows GitHub to automatically close the issue when this PR is merged.
10+
Fixes #Issue_Number
11+
12+
* Issue in another repository: use a non-closing, fully-qualified reference so it links without closing the other repository's issue:
13+
14+
Contributes to owner/repo#Issue_Number
15+
16+
Notes:
17+
18+
* If this PR only partially addresses an issue in this repository, use "Contributes to #Issue_Number" instead of "Fixes" so the issue stays open.
19+
* Never use a bare "#Issue_Number" for an issue in another repository; the bare form resolves to an issue of that number in this repository and links to the wrong issue. Always use the "owner/repo#Issue_Number" form for cross-repository references.
1120
1221
NOTE: This is a comment; please type your descriptions above or below it.
1322
-->

.github/copilot-instructions.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
author: tdykstra
33
ms.author: wpickett
4-
ms.date: 10-16-2025
4+
ms.date: 08/25/2026
55
---
66

77
# Copilot Instructions for `dotnet/AspNetCore.Docs`
@@ -157,7 +157,13 @@ When working on an issue:
157157
* [ ] When significantly updating, revise the introductory paragraph to match the new scope and content.
158158

159159
### 6. PR Description Requirements
160-
* [ ] ALWAYS include "Fixes #[issue-number]" in the PR description, at the first line of the description to link back to the original issue
160+
* [ ] On the first line of the PR description, reference the originating issue:
161+
* [ ] Issue in this repository (`dotnet/AspNetCore.Docs`): use a closing keyword: `Fixes #[issue-number]`
162+
* [ ] Issue in another repository: use a non-closing, fully-qualified reference so it links without closing: `Contributes to [owner]/[repo]#[issue-number]`
163+
* [ ] Exceptions to the above defaults:
164+
* [ ] If this PR only partially addresses an issue in this repository, use `Contributes to #[issue-number]` instead of `Fixes`, so the issue stays open.
165+
* [ ] Only use a closing keyword for an issue in another repository when a maintainer explicitly asks for it, and then use the fully-qualified form: `Fixes [owner]/[repo]#[issue-number]`.
166+
* [ ] Never use a bare `#[issue-number]` for an issue in another repository; the bare form resolves to an issue of that number in this repository and links to the wrong issue. Always use the `[owner]/[repo]#[issue-number]` form for cross-repository references.
161167
* [ ] Include a clear summary of changes made
162168
* [ ] List all files that were modified with brief descriptions
163169

0 commit comments

Comments
 (0)