Skip to content

Commit

Permalink
Add issue templates (#3054)
Browse files Browse the repository at this point in the history
  • Loading branch information
timotheeguerin authored Mar 26, 2024
1 parent 4c34e78 commit 9b083d0
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 0 deletions.
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: File a bug report
title: "[Bug]: "
labels: ["bug"]
# projects: ["octo-org/1", "octo-org/44"]
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://typespec.io/playground) or a github repo that can reproduce the problem you ran into. 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/microsoft/typespec/blob/main/CODE_OF_CONDUCT.md)
required: true

- label: Check that there isn't already an issue that request the same bug to avoid creating a duplicate.
required: true

- label: Check that this is a concrete bug. For Q&A open a [GitHub Discussion](https://github.com/Microsoft/typespec/discussions).
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: Questions & Discussions
url: https://github.com/Microsoft/typespec/discussions
about: Use GitHub discussions for message-board style questions and discussions.
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: 🚀 New feature proposal
description: Propose a new feature to be added to TypeSpec
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/microsoft/typespec/blob/main/CODE_OF_CONDUCT.md)
required: true

- label: Read the [docs](https://typespec.io/docs/).
required: true

- label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
required: true

0 comments on commit 9b083d0

Please sign in to comment.