From 0e41a606d1acc9b0fa292426d3593fff4d7589be Mon Sep 17 00:00:00 2001 From: Bill Wagner Date: Thu, 19 Dec 2024 11:49:22 -0500 Subject: [PATCH] Add new issue templates (#44034) Remove the C# 13 new issue template, and create new templates for C# 14. For this release create 3 distinct templates for the conceptual and reference content, the errors & warnings updates, and the possible tutorials. Experience tells me that maps to the PRs for a new feature. --- .../04-csharp-new-fundamentals-reference.yml | 66 +++++++++++++ .../ISSUE_TEMPLATE/04-new-feature-csharp.yml | 96 ------------------- .../05-csharp-new-errors-warnings.yml | 57 +++++++++++ .../06-csharp-new-tutorials.yml | 59 ++++++++++++ 4 files changed, 182 insertions(+), 96 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/04-csharp-new-fundamentals-reference.yml delete mode 100644 .github/ISSUE_TEMPLATE/04-new-feature-csharp.yml create mode 100644 .github/ISSUE_TEMPLATE/05-csharp-new-errors-warnings.yml create mode 100644 .github/ISSUE_TEMPLATE/06-csharp-new-tutorials.yml diff --git a/.github/ISSUE_TEMPLATE/04-csharp-new-fundamentals-reference.yml b/.github/ISSUE_TEMPLATE/04-csharp-new-fundamentals-reference.yml new file mode 100644 index 0000000000000..6114867558c22 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/04-csharp-new-fundamentals-reference.yml @@ -0,0 +1,66 @@ +name: "C# 14 - New feature - Fundamentals and reference" +description: Create the issue for adding reference docs and optional fundamentals updates for a new feature in C# 14 +title: "[C# 14-Fundamentals and reference]: New Feature - " +labels: + - ":checkered_flag: Release: .NET 10" + - dotnet-csharp/svc + - whats-new/subsvc +assignees: + - billwagner +body: + - type: dropdown + id: version + attributes: + label: Visual Studio release + description: What Visual Studio (preview) contains this feature? + options: + - "17.13.p3" + - "17.13" + - "17.14.p1" + - "17.14.p2" + - "17.14.p3" + - "17.14.p4" + - "17.14.p5" + - "17.14.p6" + - "17.14" + - "other - specify below" + - type: input + id: Speclet + attributes: + label: Link to speclet + description: Insert the markdown format for a link to the speclet + value: "- [Speclet](https://github.com/dotnet/csharplang/blob/main/proposals/feature.md)" + validations: + required: true + - type: input + id: pullrequest + attributes: + label: Link to Pull request + description: Insert the markdown format for a link to the PR + value: "- [PR](https://github.com/dotnet/roslyn/pull/nnnnn)" + validations: + required: true + - type: textarea + id: new-behavior + attributes: + label: New behavior + description: Describe the new behavior. Include code snippets if applicable. + validations: + required: true + - type: textarea + id: language-reference + attributes: + label: Language reference tasks + description: Add a list of areas or articles in the language reference that should be updated for this feature. + placeholder: | + - Syntax directly affected + - Related language elements that should include use of this new feature + - Areas where the new feature reduces friction + - type: textarea + id: fundamentals + attributes: + label: Everyday C# tasks + description: Add a list of any articles in the new Everyday C# section that should be updated. + placeholder: | + - How will this be used as part of *Everyday C#*? + - If not applicable, write that. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/04-new-feature-csharp.yml b/.github/ISSUE_TEMPLATE/04-new-feature-csharp.yml deleted file mode 100644 index 700be76884e4f..0000000000000 --- a/.github/ISSUE_TEMPLATE/04-new-feature-csharp.yml +++ /dev/null @@ -1,96 +0,0 @@ -name: "C# 13 - New feature" -description: Create the task list of a new feature in C# 13. Intended mostly for docs / product-team use. -title: "[C# 13]: New Feature - " -labels: - - ":checkered_flag: Release: .NET 9" - - Pri1 - - dotnet-csharp/svc - - whats-new/subsvc -assignees: - - billwagner -body: - - type: dropdown - id: version - attributes: - label: Visual Studio release - description: What Visual Studio (preview) contains this feature? - options: - - "17.9p3" - - "17.9p4" - - "17.9p5" - - "17.9" - - "17.10p1" - - "17.10p2" - - "17.10p3" - - "17.10p4" - - "17.10p6" - - "17.10" - - "17.11p1" - - "17.11p2" - - "17.11p3" - - "17.11p4" - - "Other (please put exact version in description textbox)" - - type: input - id: Speclet - attributes: - label: Link to speclet - description: Insert the markdown format for a link to the speclet - value: "- [Speclet](https://github.com/dotnet/csharplang/blob/main/proposals/feature.md)" - validations: - required: true - - type: input - id: pullrequest - attributes: - label: Link to Pull request - description: Insert the markdown format for a link to the PR - value: "- [PR](https://github.com/dotnet/roslyn/pulls/nnnnn)" - validations: - required: true - - type: textarea - id: new-behavior - attributes: - label: New behavior - description: Describe the new behavior. Include code snippets if applicable. - validations: - required: true - - type: checkboxes - id: task-list - attributes: - label: Areas affected - description: Check all areas that must be updated. Some are always updated. - options: - - label: "**Add to What's new in C# 13**: Add links to updated docs in the What's new in C# 13 article." - required: true - - label: "**Update language reference**: Detail the areas in the language reference that will be updated for this feature." - required: true - - label: "**Update compiler messages**: Add new (or updated) pages for new compiler messages. Include related message." - required: true - - label: "*Include in *Everyday C#* section**: Is this new feature included in Everyday C#?" - required: false - - label: "**Tutorials**: Are new tutorials required for this feature? If so, detail below" - required: false - - type: textarea - id: language-reference - attributes: - label: Language reference tasks - description: Add a list of areas or articles in the language reference that should be updated for this feature. - placeholder: | - - Syntax directly affected - - Related language elements that should include use of this new feature - - Areas where the new feature reduces friction - - type: textarea - id: tutorials - attributes: - label: Tutorial tasks - description: Add a list of topics that should be covered in one or more tutorials related to this feature. - placeholder: | - - Syntax directly affected - - Related language elements that should include use of this new feature - - Areas where the new feature reduces friction - - type: textarea - id: fundamentals - attributes: - label: Everyday C# tasks - description: Add a list of any articles in the new Everyday C# section that should be updated. - placeholder: | - - How will this be used as part of *Everyday C#*? diff --git a/.github/ISSUE_TEMPLATE/05-csharp-new-errors-warnings.yml b/.github/ISSUE_TEMPLATE/05-csharp-new-errors-warnings.yml new file mode 100644 index 0000000000000..94f42d700d9fc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/05-csharp-new-errors-warnings.yml @@ -0,0 +1,57 @@ +name: "C# 14 - New feature - Errors and warnings" +description: Create the issue for adding reference docs for new compiler warnings and errors added in a new feature in C# 14 +title: "[C# 14-Errors and warnings]: New Feature - " +labels: + - ":checkered_flag: Release: .NET 10" + - okr-curation + - dotnet-csharp/svc + - whats-new/subsvc +assignees: + - billwagner +body: + - type: dropdown + id: version + attributes: + label: Visual Studio release + description: What Visual Studio (preview) contains this feature? + options: + - "17.13.p3" + - "17.13" + - "17.14.p1" + - "17.14.p2" + - "17.14.p3" + - "17.14.p4" + - "17.14.p5" + - "17.14.p6" + - "17.14" + - "other - specify below" + - type: input + id: Speclet + attributes: + label: Link to speclet + description: Insert the markdown format for a link to the speclet + value: "- [Speclet](https://github.com/dotnet/csharplang/blob/main/proposals/feature.md)" + validations: + required: true + - type: input + id: pullrequest + attributes: + label: Link to Pull request + description: Insert the markdown format for a link to the PR + value: "- [PR](https://github.com/dotnet/roslyn/pull/nnnnn)" + validations: + required: true + - type: textarea + id: errors-warnings + attributes: + label: Errors and warnings added for this feature + description: Add the list of IDs and message from the relevant PR + placeholder: | + - CSnnnn: Message + - type: textarea + id: theme + attributes: + label: What language theme applies, for consolidation of articles + description: Consider what syntax areas are affected for consolidating existing errors and warnings + placeholder: | + Consider themes in syntax affected by the new set of errors are warnings diff --git a/.github/ISSUE_TEMPLATE/06-csharp-new-tutorials.yml b/.github/ISSUE_TEMPLATE/06-csharp-new-tutorials.yml new file mode 100644 index 0000000000000..0760c0d76eef5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/06-csharp-new-tutorials.yml @@ -0,0 +1,59 @@ +name: "C# 14 - New feature - Additional tutorials" +description: Create the issue for adding new tutorials for a new feature in C# 14 +title: "[C# 14-Tutorials]: New Feature - " +labels: + - ":checkered_flag: Release: .NET 10" + - dotnet-csharp/svc + - whats-new/subsvc +assignees: + - billwagner +body: + - type: dropdown + id: version + attributes: + label: Visual Studio release + description: What Visual Studio (preview) contains this feature? + options: + - "17.13.p3" + - "17.13" + - "17.14.p1" + - "17.14.p2" + - "17.14.p3" + - "17.14.p4" + - "17.14.p5" + - "17.14.p6" + - "17.14" + - "other - specify below" + - type: input + id: Speclet + attributes: + label: Link to speclet + description: Insert the markdown format for a link to the speclet + value: "- [Speclet](https://github.com/dotnet/csharplang/blob/main/proposals/feature.md)" + validations: + required: true + - type: input + id: pullrequest + attributes: + label: Link to Pull request + description: Insert the markdown format for a link to the PR + value: "- [PR](https://github.com/dotnet/roslyn/pull/nnnnn)" + validations: + required: true + - type: textarea + id: new-behavior + attributes: + label: New behavior + description: Describe the new behavior. Include code snippets if applicable. + validations: + required: true + - type: textarea + id: tutorials + attributes: + label: New tutorials + description: Add a list of scenarios and tutorials related to the new feature. If this doesn't apply, don't submit the issue. + placeholder: | + - Detail scenarios that should be covered + - Classify tutorials as "fundamentals", "advanced", or targeted at subsets of C# developers (e.g. web, game, mobile) + - Consider use cases where the feature would be used in practice + -