From 076e2d696db3dc4145e2c782052c69d7ca163283 Mon Sep 17 00:00:00 2001 From: Timothee Guerin Date: Wed, 27 Mar 2024 14:50:53 -0700 Subject: [PATCH] Migrate issue templates to forms (#520) Convert to form so its not just a template that can be easily ignored. Actively recommend repro steps with the playground. image --------- Co-authored-by: Mark Cowlishaw --- .github/ISSUE_TEMPLATE/0_general.md | 4 -- .github/ISSUE_TEMPLATE/bug-report.md | 19 ------- .github/ISSUE_TEMPLATE/bug-report.yml | 46 ++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 4 ++ .github/ISSUE_TEMPLATE/feature-request.md | 18 ------ .github/ISSUE_TEMPLATE/feature-request.yml | 32 +++++++++++ .github/ISSUE_TEMPLATE/onboarding-request.md | 40 -------------- .github/ISSUE_TEMPLATE/onboarding-request.yml | 55 +++++++++++++++++++ ...ange-form.md => z_breaking-change-form.md} | 2 +- CODE_OF_CONDUCT.md | 9 +++ 10 files changed, 147 insertions(+), 82 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/0_general.md delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/onboarding-request.md create mode 100644 .github/ISSUE_TEMPLATE/onboarding-request.yml rename .github/ISSUE_TEMPLATE/{breaking-change-form.md => z_breaking-change-form.md} (92%) create mode 100644 CODE_OF_CONDUCT.md diff --git a/.github/ISSUE_TEMPLATE/0_general.md b/.github/ISSUE_TEMPLATE/0_general.md deleted file mode 100644 index 187f544395..0000000000 --- a/.github/ISSUE_TEMPLATE/0_general.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -name: TypeSpec Azure general issue -about: for general TypeSpec Azure issue. ---- diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 80a0fe9418..0000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: Bug Report -about: Report bugs or unexpected behaviors of TypeSpec Azure -title: "[Bug] {Bug title} " -labels: bug -assignees: "" ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000000..a68eaac57c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,46 @@ +name: 🐞 Bug Report +description: Report bugs or unexpected behaviors of TypeSpec Azure +title: "[Bug]: " +labels: ["bug"] + +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks! + placeholder: Bug description + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Reproduction + description: Please provide a link to [Playground](https://azure.github.io/typespec/playground) or a [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) is required unless you are absolutely sure that the issue is obvious and the provided information is enough to understand the problem. + placeholder: Reproduction + validations: + required: true + + - type: checkboxes + id: checklist + attributes: + label: Checklist + description: Before submitting the issue, please make sure you do the following + options: + - label: Follow our [Code of Conduct](https://github.com/azure/typespec-azure/blob/main/CODE_OF_CONDUCT.md) + required: true + + - label: Check that this issue is about the Azure libraries for typespec. For bug in the typespec language or core libraries file it in the [TypeSpec repo](https://github.com/Microsoft/TypeSpec/issues/new/choose) + required: true + + - label: Check that there isn't already an issue that request the same bug to avoid creating a duplicate. + required: true + + - label: The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug. + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..97de78d8d6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,4 @@ +contact_links: + - name: TypeSpec Core Language and Libraries Issue + url: https://github.com/Microsoft/typespec/new/choose + about: For bug and feature request on the TypeSpec language or core libraries go here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 60ffb1305a..0000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -name: Feature Request -about: Request TypeSpec Azure features -title: "[Feature Request] {Title} " -assignees: "" ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000000..3ba06b7e4c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,32 @@ +name: 🚀 New feature proposal +description: Propose a new feature to be added to TypeSpec Azure +labels: [] +body: + - type: markdown + attributes: + value: | + Thanks for your interest in the project and taking the time to fill out this feature report! + - type: textarea + id: feature-description + attributes: + label: Clear and concise description of the problem + validations: + required: true + + - type: checkboxes + id: checklist + attributes: + label: Checklist + description: Before submitting the issue, please make sure you do the following + options: + - label: Follow our [Code of Conduct](https://github.com/azure/typespec-azure/blob/main/CODE_OF_CONDUCT.md) + required: true + + - label: Check that this issue is about the Azure libraries for typespec. For feature request in the typespec language or core libraries file it in the [TypeSpec repo](https://github.com/Microsoft/TypeSpec/issues/new/choose) + required: true + + - label: Read the [docs](https://azure.github.io/typespec-azure/). + required: true + + - label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate. + required: true diff --git a/.github/ISSUE_TEMPLATE/onboarding-request.md b/.github/ISSUE_TEMPLATE/onboarding-request.md deleted file mode 100644 index e8369bffc0..0000000000 --- a/.github/ISSUE_TEMPLATE/onboarding-request.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -name: Onboarding request -about: One time onboarding form to help TypeSpec team to provide better support. -title: "[Onboarding] {ProviderName} {ARM|Data-plane} " -labels: onboarding -assignees: "" ---- - -**Please update issue title with provider name and select ARM or Data-plane.** - ---- - -**Service Team Contacts** -Dev: -PM: - -**Tell us what stage you are currently at with TypeSpec for your API definition** - -- [ ] Just heard about TypeSpec, tell me more. -- [ ] Started modeling with TypeSpec. -- [ ] Dogfooding with TypeSpec. -- [ ] Going Private Preview with TypeSpec. -- [ ] Going for Public Preview with TypeSpec. -- [ ] We are live. - -**What's your next milestone ** - -1. Milestone: Private Preview | Public Preview - -- Target Date: - -2. Milestone: Private Preview | Public Preview - -- Target Date: - -**Link to your repo if available** -[Repo Link](...) - -**Additional notes or questions** -Add any other context or questions here. diff --git a/.github/ISSUE_TEMPLATE/onboarding-request.yml b/.github/ISSUE_TEMPLATE/onboarding-request.yml new file mode 100644 index 0000000000..eb8d7caac4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/onboarding-request.yml @@ -0,0 +1,55 @@ +name: Onboarding request +description: One time onboarding form to help TypeSpec team to provide better support. +title: "[Onboarding] {ProviderName} {ARM|Data-plane} " +labels: ["onboarding"] + +body: + - type: input + id: contact-dev + attributes: + label: Service Team Contacts (Dev) + + - type: input + id: contact-pm + attributes: + label: Service Team Contacts (PM) + + - type: dropdown + id: stage + attributes: + label: Tell us what stage you are currently at with TypeSpec for your API definition + options: + - Just heard about TypeSpec, tell me more. + - Started modeling with TypeSpec. + - Dogfooding with TypeSpec. + - Going Private Preview with TypeSpec. + - Going for Public Preview with TypeSpec. + - We are live. + + - type: textarea + id: next-millestone + attributes: + label: What's your next milestone (Private Preview | Public Preview, target date, etc.) + + - type: input + id: repo-link + attributes: + label: Link to your repo if available + + - type: textarea + id: additional-notes + attributes: + label: Additional notes or questions + description: Add any other context or questions here. + + - type: checkboxes + id: checklist + attributes: + label: Checklist + description: Before submitting the issue, please make sure you do the following + options: + - label: Follow our [Code of Conduct](https://github.com/azure/typespec-azure/blob/main/CODE_OF_CONDUCT.md) + required: true + + - label: Please update issue title with provider name and select ARM or Data-plane. + required: true diff --git a/.github/ISSUE_TEMPLATE/breaking-change-form.md b/.github/ISSUE_TEMPLATE/z_breaking-change-form.md similarity index 92% rename from .github/ISSUE_TEMPLATE/breaking-change-form.md rename to .github/ISSUE_TEMPLATE/z_breaking-change-form.md index 9915254960..3a5edc7895 100644 --- a/.github/ISSUE_TEMPLATE/breaking-change-form.md +++ b/.github/ISSUE_TEMPLATE/z_breaking-change-form.md @@ -1,5 +1,5 @@ --- -name: Breaking Change Review Form +name: "[Internal Use] Breaking Change Review Form" about: Requesting Breaking Change Review for TypeSpec Azure features title: "[Breaking Change Review] {title} " labels: Breaking Change Review diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000..f9ba8cf65f --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,9 @@ +# Microsoft Open Source Code of Conduct + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). + +Resources: + +- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/) +- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) +- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns