diff --git a/.github/prompts/whats-new-net.md b/.github/prompts/whats-new-net.md new file mode 100644 index 0000000000000..5180e98d7f1bd --- /dev/null +++ b/.github/prompts/whats-new-net.md @@ -0,0 +1,44 @@ +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: + +## Task + +You'll update 4 articles. For .NET 10, you update these: + +- https://github.com/dotnet/docs/blob/main/docs/core/whats-new/dotnet-10/overview.md +- https://github.com/dotnet/docs/blob/main/docs/core/whats-new/dotnet-10/runtime.md +- https://github.com/dotnet/docs/blob/main/docs/core/whats-new/dotnet-10/libraries.md +- https://github.com/dotnet/docs/blob/main/docs/core/whats-new/dotnet-10/sdk.md + +For other releases, replace "dotnet-10" in the preceding paths with the correct release. For example, use "dotnet-11" for the ".NET 11" releases. + +## Source material + +To learn what's new in the targeted release, use the corresponding release notes in the [dotnet core](https://github.com/dotnet/core) repository. The release notes will be in a subfolder of the "release-notes" folder. + +For production releases, the path is `/`, where: + +- `` is the release number. For example, `8.0`, `9.0` or `10.0`. +- `` is the three part release number. For example, `8.0.3`, `9.0.6` or `10.0.0`. + +For preview releases, the path is `/preview/preview` where: + +- `` 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 contains links to other release notes for components of .NET: libraries, runtime, SDK, languages, and so on. Use all that information for source. + +## Updates for each file + +- Each file should have its `ms.date` metadata field updated to match the date you're assigned the issue. +- 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. Or, add applicable information from the release notes into existing feature articles where it makes sense. +- 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 an `xref` style link, at least on first mention. +- All links to article in the `dotnet/docs` repository should be file relative. +- Spell out acronyms on first use in each file. +- In general, don't mention specific contributors or pull requests to the product repos. + +Next, create a pull request. In the description, include the text "Fixes #\", where "issue-number" is the GitHub issue number.