Replaced old markdown Issue template with new GitHub forms templates (#3468)

This PR replaces the old markdown issue template with the new YAML based form templates for GitHub, this allows us to enforce required fields and also auto-tag with labels.

This doesn't remove the ability to open a blank issue, but it is obscured so it is not the primary thing people are likely to do.

This also added link entries in the issue creation page to link to the Discussions tab, Community Slack, and IRC channel.
This commit is contained in:
Aki 2022-09-05 10:45:43 -04:00 committed by GitHub
parent 1bc6ea2366
commit 3f04931adb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 100 additions and 24 deletions

63
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@ -0,0 +1,63 @@
name: Bug Report
description: Report an issue or regression with Yosys
labels: ["pending-verification"]
body:
- type: markdown
attributes:
value: >
If you have a general question, please ask it in the [Discussions](https://github.com/YosysHQ/yosys/discussions) area
or join our [IRC Channel](https://web.libera.chat/#yosys) or [Community Slack](https://join.slack.com/t/yosyshq/shared_invite/zt-1aopkns2q-EiQ97BeQDt_pwvE41sGSuA).
If you have a feature request, please fill out the appropriate issue form, this form is for bugs and/or regressions.
Please contact [YosysHQ GmbH](https://www.yosyshq.com/) if you need
commercial support for Yosys.
- type: input
id: yosys_version
attributes:
label: Version
description: "The version of yosys this bug was encountered on."
placeholder: "The output of `yosys --version`"
validations:
required: true
- type: markdown
attributes:
value: >
When providing steps to reproduce the issue, please ensure that the issue
is reproducible in the current git master of Yosys. Also ensure to
provide all necessary source files needed.
Please see [https://stackoverflow.com/help/mcve](https://stackoverflow.com/help/mcve)
for information on how to create a Minimal, Complete, and Verifiable Example
(MCVE).
- type: textarea
id: reproduction_steps
attributes:
label: Reproduction Steps
description: "Please provide clear and concise steps to reproduce the issue."
validations:
required: true
- type: textarea
id: expected_behavior
attributes:
label: Expected Behavior
description: "Please describe the behavior you would have expected from the tool."
validations:
required: true
- type: textarea
id: actual_behavior
attributes:
label: Actual Behavior
description: "Please describe how the behavior you see differs from the expected behavior."
validations:
required: true

11
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,11 @@
contact_links:
- name: Discussions
url: https://github.com/YosysHQ/yosys/discussions
about: "Have a question? Ask it on our discussions page!"
- name: Community Slack
url: https://join.slack.com/t/yosyshq/shared_invite/zt-1aopkns2q-EiQ97BeQDt_pwvE41sGSuA
about: "Yosys Community Slack"
- name: IRC Channel
url: https://web.libera.chat/#yosys
about: "#yosys on irc.libera.chat"

View File

@ -0,0 +1,26 @@
name: Feature Request
description: "Submit a feature request for Yosys"
labels: ["feature-request"]
body:
- type: markdown
attributes:
value: >
If you have a general question, please ask it in the [Discussions](https://github.com/YosysHQ/yosys/discussions) area
or join our [IRC Channel](https://web.libera.chat/#yosys) or [Community Slack](https://join.slack.com/t/yosyshq/shared_invite/zt-1aopkns2q-EiQ97BeQDt_pwvE41sGSuA).
If you have a bug report, please fill out the appropriate issue form, this form is for feature requests.
Please contact [YosysHQ GmbH](https://www.yosyshq.com/) if you need
commercial support or work done for Yosys.
- type: textarea
id: feature_description
attributes:
label: Feature Description
description: "A clear and detailed description of the feature."
validations:
required: true

View File

@ -1,24 +0,0 @@
## Steps to reproduce the issue
*Provide instructions for reproducing the issue. Make sure to include
all necessary source files. (You can simply drag&drop a .zip file into
the issue editor.)*
Also, make sure that the issue is actually reproducable in current git
master of Yosys.
See https://stackoverflow.com/help/mcve for some information on how to
create a Minimal, Complete, and Verifiable example (MCVE).
Please do not waste our time with issues that lack sufficient information
to reproduce the issue easily. We will simply close those issues.
Contact https://www.yosyshq.com/ if you need commercial support for Yosys.
## Expected behavior
*Please describe the behavior you would have expected from the tool.*
## Actual behavior
*Please describe how the behavior you see differs from the expected behavior.*