Add copilot instructions for What's New #47442
Open
+43
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a copilot prompt file for assigning "What's new" issues to Copilot.
gewarren
approved these changes
Jul 17, 2025
| @@ -0,0 +1,43 @@ | |||
| When you're assigned an issue where one label includes the word "Release" and you're given a link to an issue with this prompt file as context to update the what's new in .NET pages, follow these guidelines: | |||
There was a problem hiding this comment.
How do you add this file as context to the issue?
There was a problem hiding this comment.
NVM, that's if you use GH Copilot through VS Code.
| - `<major-release>` is the release number. For example, `8.0`, `9.0` or `10.0`. | ||
| - `n` is the preview number. For example, `1`, `3`, or `6`. | ||
|
|
||
| The primary release notes are in the `README.MD` file in that folder. That file will contain links to other release notes for parts of .NET: libraries, runtime, sdk, languages, and so on. Use all that information for source. |
There was a problem hiding this comment.
Suggested change
| The primary release notes are in the `README.MD` file in that folder. That file will contain links to other release notes for parts of .NET: libraries, runtime, sdk, languages, and so on. Use all that information for source. | |
| The primary release notes are in the `README.MD` file in that folder. That file contains links to other release notes for components of .NET: libraries, runtime, SDK, languages, and so on. Use all that information for source. |
|
|
||
| The primary release notes are in the `README.MD` file in that folder. That file will contain links to other release notes for parts of .NET: libraries, runtime, sdk, languages, and so on. Use all that information for source. | ||
|
|
||
| ## Updates for each file. |
There was a problem hiding this comment.
Suggested change
| ## Updates for each file. | |
| ## Updates for each file |
|
|
||
| ## Updates for each file. | ||
|
|
||
| - Each file should have its `ms.date` metadata field updated to match today's date. |
There was a problem hiding this comment.
Suggested change
| - Each file should have its `ms.date` metadata field updated to match today's date. | |
| - Each file should have its `ms.date` metadata field updated to match the date you're assigned the issue. |
| - Each file should have its `ms.date` metadata field updated to match today's date. | ||
| - Ensure each file has the `ai-usage: ai-assisted` metadata field added. | ||
| - Update phrasing on the latest update to reference the current release (preview, GA, or service release). Individual features shouldn't reference a given preview release, but the article should make it clear which was the last preview. | ||
| - Search this repository for articles that have been recently updated pertaining to new features. Add links to those as you write about that feature. |
There was a problem hiding this comment.
Suggested change
| - Search this repository for articles that have been recently updated pertaining to new features. Add links to those as you write about that feature. | |
| - Search this repository for articles that have been recently updated pertaining to new features. Add links to those as you write about that feature. Or, add applicable information from the release notes into existing feature articles where it makes sense. |
There was a problem hiding this comment.
In reality, I think it might not be useful to have copilot search the repo for updated files, because 99% of the time those articles haven't been updated.
| - Update phrasing on the latest update to reference the current release (preview, GA, or service release). Individual features shouldn't reference a given preview release, but the article should make it clear which was the last preview. | ||
| - Search this repository for articles that have been recently updated pertaining to new features. Add links to those as you write about that feature. | ||
| - For the runtime and libraries articles, include extensive examples as well as links to recently updated articles related to the new feature. The examples should be at least as thorough as the examples from the source release notes. | ||
| - Where applicable, the sdk article should include the samples. |
There was a problem hiding this comment.
Suggested change
| - Where applicable, the sdk article should include the samples. | |
| - Where applicable, the SDK article should include the samples. |
| - For the runtime and libraries articles, include extensive examples as well as links to recently updated articles related to the new feature. The examples should be at least as thorough as the examples from the source release notes. | ||
| - Where applicable, the sdk article should include the samples. | ||
| - The overview article generally doesn't include examples. Its purpose is to direct readers to more detailed information in other articles. | ||
| - All APIs should be referenced using the `xref` tag on first mention. The `displayProperty=nameWithType` should be used. |
There was a problem hiding this comment.
Suggested change
| - All APIs should be referenced using the `xref` tag on first mention. The `displayProperty=nameWithType` should be used. | |
| - All APIs should be referenced using an `xref` style link, at least on first mention. |
| - The overview article generally doesn't include examples. Its purpose is to direct readers to more detailed information in other articles. | ||
| - All APIs should be referenced using the `xref` tag on first mention. The `displayProperty=nameWithType` should be used. | ||
| - All links to article in the `dotnet/docs` repository should be file relative. | ||
| - Spell out acronyms on first use in each file. |
There was a problem hiding this comment.
Suggested change
| - Spell out acronyms on first use in each file. | |
| - Spell out acronyms on first use in each file. | |
| - In general, don't mention specific contributors or pull requests to the product repos. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a copilot prompt file for assigning "What's new" issues to Copilot.
Internal previews