diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000..6387af06a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,62 @@ +name: 🐞 Bug +description: File a bug/issue +title: "bug: " +labels: [bug] +body: + - type: markdown + attributes: + value: | + _The more information you share, the faster we can help you._ + Prior to opening the issue, please make sure that you: + - Use English (EN/US) to communicate. + - Search the [open issues](https://github.com/hyperledger/firefly/issues) to avoid duplicating the issue. + + - type: textarea + id: problem + attributes: + label: What happened? + description: | + Please provide as much info as possible. Not doing so may result in your bug not being addressed in a timely manner. + If this matter is security related, please disclose it privately via security@lfdecentralizedtrust.org + validations: + required: true + + - type: textarea + id: expected + attributes: + label: What did you expect to happen? + validations: + required: true + + - type: textarea + id: repro + attributes: + label: How can we reproduce it (as minimally and precisely as possible)? + validations: + required: true + + - type: textarea + id: additional + attributes: + label: Anything else we need to know? + + - type: textarea + id: osVersion + attributes: + label: OS version + value: | +
+ + ```console + # On Linux: + $ cat /etc/os-release + # paste output here + $ uname -a + # paste output here + + # On Windows: + C:\> wmic os get Caption, Version, BuildNumber, OSArchitecture + # paste output here + ``` + +
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..51cdb2da7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Support Request + url: https://discord.gg/hyperledger + about: Support request or question relating to Hyperledger Firefly diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml new file mode 100644 index 000000000..7ba36d42b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -0,0 +1,27 @@ +name: Enhancement Tracking Issue +description: Provide supporting details for an enhancement +labels: [enhancement] +body: + - type: markdown + attributes: + value: | + _The more information you share, the faster we can help you._ + Prior to opening the issue, please make sure that you: + - Use English (EN/US) to communicate. + - Search the [open issues](https://github.com/hyperledger/firefly/issues) to avoid duplicating the issue. + + - type: textarea + id: enhancement + attributes: + label: What would you like to be added? + description: | + A clear and concise description of what you want to happen. + validations: + required: true + + - type: textarea + id: rationale + attributes: + label: Why is this needed? + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/improve_docs.yml b/.github/ISSUE_TEMPLATE/improve_docs.yml new file mode 100644 index 000000000..13220bcdc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/improve_docs.yml @@ -0,0 +1,31 @@ +name: "Documentation Issue" +description: Issues related to documentation. +title: "docs: " +labels: [documentation] +body: + - type: markdown + attributes: + value: | + _The more information you share, the faster we can help you._ + Prior to opening the issue, please make sure that you: + - Use English (EN/US) to communicate. + - Search the [open issues](https://github.com/hyperledger/firefly/issues) to avoid duplicating the issue. + + - type: textarea + id: current-state + attributes: + label: Current State + description: Describe the current state of the documentation. + placeholder: | + The documentation for the API in this page (url) is missing ... + validations: + required: true + - type: textarea + id: desired-state + attributes: + label: Desired State + description: Describe the desired state the documentation should be in. + placeholder: | + Add here ... + validations: + required: true