Skip to content

Commit

Permalink
Migrate issue templates to forms (#520)
Browse files Browse the repository at this point in the history
Convert to form so its not just a template that can be easily ignored.
Actively recommend repro steps with the playground.
<img width="1034" alt="image"
src="https://github.com/Azure/typespec-azure/assets/1031227/cbd1be41-855b-413c-9477-e5eadb6cb6e2">

---------

Co-authored-by: Mark Cowlishaw <[email protected]>
  • Loading branch information
timotheeguerin and markcowl authored Mar 27, 2024
1 parent 4db3c45 commit 076e2d6
Show file tree
Hide file tree
Showing 10 changed files with 147 additions and 82 deletions.
4 changes: 0 additions & 4 deletions .github/ISSUE_TEMPLATE/0_general.md

This file was deleted.

19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/bug-report.md

This file was deleted.

46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -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
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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.
18 changes: 0 additions & 18 deletions .github/ISSUE_TEMPLATE/feature-request.md

This file was deleted.

32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -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
40 changes: 0 additions & 40 deletions .github/ISSUE_TEMPLATE/onboarding-request.md

This file was deleted.

55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/onboarding-request.yml
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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
Expand Down
9 changes: 9 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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 [[email protected]](mailto:[email protected]) with questions or concerns

0 comments on commit 076e2d6

Please sign in to comment.