Replace "bug report" issue template with issue forms. (#9352)
Progress on https://github.com/google/iree/issues/7890. See GitHub's docs on [creating issue forms](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms).
Try this out here: https://github.com/ScottTodd/iree/issues/new/choose. Here's an example issue: https://github.com/ScottTodd/iree/issues/6 (note the "_No response_", how the multiple choice selection uses commas, and how the sections are set up. Definitely open to trying more ways to make both the form and the final submitted issues more useful.
It would also be nice to link to a page dedicated to getting useful error reports, maybe with a flow chart or something to help direct users coming in from TOSA/MHLO/etc.
Co-authored-by: Geoffrey Martin-Noble <gcmn@google.com>
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index bbcebcd..0000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,31 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: "bug \U0001F41E, help wanted"
-
----
-
-If you are an IREE team member, please consider doing further triage: remove the "help wanted" label, add other relevant labels, and redirect to a more appropriate assignee.
-
-**Describe the bug**
-
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-
-If you believe this is an issue with IREE core (not integrations) please provide a reproduction (including artifacts) that does not require integrations.
-
-* [Instructions for extracting artifacts from your own TF tests](https://github.com/google/iree/blob/main/docs/developers/developing_iree/e2e_benchmarking.md)
-* [Instructions for extracting artifacts from existing TF/iree-samples tests](https://github.com/google/iree/blob/main/docs/developers/debugging/integration_correctness_issue_breakdown.md#decouple-the-reproduce-from-integrations)
-
-Steps to reproduce the behavior:
-
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**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 0000000..1d22372
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,58 @@
+name: 🐞 Bug Report
+description: Report an issue
+labels: ["awaiting-triage", "bug 🐞"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ :star2: Thanks for taking the time to report this issue! :star2:
+
+ Please search through [other recent issues](https://github.com/google/iree/issues) to see if your report overlaps with an existing issue.
+ - type: textarea
+ id: what-happened
+ attributes:
+ label: What happened?
+ description: |
+ Also tell us, what did you expect to happen?
+
+ For compiler errors, we like to see the MLIR output leading up to whatever error occurred.
+ placeholder: Tell us what you see! Please also copy/paste or link to any relevant log output.
+ validations:
+ required: true
+ - type: textarea
+ id: reproducing
+ attributes:
+ label: Steps to reproduce your issue
+ description: |
+ For compiler errors, we like to see the input IR and the commands that you ran.
+ value: |
+ 1. Go to '...'
+ 2. Click on '....'
+ 3. Scroll down to '....'
+ 4. See error
+ - type: dropdown
+ id: component
+ attributes:
+ label: What component(s) does this issue relate to?
+ description: |
+ If you're not sure, that's okay! This helps us route issues to the right developers.
+ multiple: true
+ options:
+ - Frontends
+ - MLIR
+ - Python
+ - Compiler
+ - Runtime
+ - Other
+ - type: textarea
+ id: version
+ attributes:
+ label: Version information
+ description: What version of our software are you running?
+ placeholder: This could be a git commit hash or release version number.
+ - type: textarea
+ id: additional-context
+ attributes:
+ label: Additional context
+ description: Add any other context about the problem here.
+ placeholder: For example, did what you were trying work before?
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..c6f5b21
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,11 @@
+blank_issues_enabled: true
+contact_links:
+ - name: 📧 Send an email to our mailing list
+ url: https://groups.google.com/forum/#!forum/iree-discuss
+ about: For announcements and asynchronous discussion
+ - name: 🗣 Start a discussion on GitHub
+ url: https://github.com/google/iree/discussions
+ about: An alternative platform for asynchronous discussion
+ - name: 💬 Join us on Discord
+ url: https://discord.gg/26P4xW4
+ about: For realtime communication with the team and collaborators
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 0000000..1cfb36e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,38 @@
+name: ➕ Feature Request
+description: Ask for a new feature to be added
+labels: ["awaiting-triage", "enhancement ➕"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ :star2: Thanks for taking the time to file this request! :star2:
+
+ We also work closely with upstream communities like the MLIR project, which uses the [MLIR Discourse forum](https://discourse.llvm.org/c/mlir/31) for coordination.
+ - type: textarea
+ id: overview
+ attributes:
+ label: Request description
+ description: |
+ What would you like added or changed?
+ validations:
+ required: true
+ - type: dropdown
+ id: component
+ attributes:
+ label: What component(s) does this issue relate to?
+ description: |
+ If you're not sure, that's okay! This helps us route issues to the right developers.
+ multiple: true
+ options:
+ - Frontends
+ - MLIR
+ - Python
+ - Compiler
+ - Runtime
+ - Other
+ - type: textarea
+ id: additional-context
+ attributes:
+ label: Additional context
+ description: Add any other context about your request here.
+ placeholder: For example, is a similar feature already implemented?
