-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This introduces some basic Github issue templates that can be used for creating bug reports, security vulnerability reports, and basic feature requests.
- Loading branch information
1 parent
ecdbfda
commit 666e583
Showing
4 changed files
with
227 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| name: Bug Report | ||
| description: 🪲 File a Bug report | ||
| title: "[Bug]: " | ||
| labels: ["bug", "triage"] | ||
| assignees: | ||
| - bitwizeshift | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: Thank you for taking the time to fill out this bug report! | ||
| - type: textarea | ||
| id: what-happened | ||
| attributes: | ||
| label: What happened? | ||
| description: Please describe what you experienced for the bug | ||
| placeholder: Tell us what you see! | ||
| value: A bug happened | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: steps-to-reproduce | ||
| attributes: | ||
| label: Steps to Reproduce | ||
| description: "How do you trigger this bug? Please walk us through it step by step." | ||
| placeholder: | | ||
| 1. | ||
| 2. | ||
| 3. | ||
| ... | ||
| render: bash | ||
| - type: textarea | ||
| id: expected-behavior | ||
| attributes: | ||
| label: What did you expect to see happen? | ||
| description: | | ||
| Please describe what you were expecting to see. | ||
| Include sample inputs and outputs, if relevant. Leave empty if not applicable. | ||
| - type: textarea | ||
| id: actual-behavior | ||
| attributes: | ||
| label: What did you actually see happen? | ||
| description: | | ||
| Please describe what you actually saw occur. | ||
| Include sample inputs and outputs, if relevant. Leave empty if not applicable. | ||
| - type: dropdown | ||
| id: systems | ||
| attributes: | ||
| label: What systems are you seeing the problem on? | ||
| multiple: true | ||
| options: | ||
| - macOS | ||
| - Windows | ||
| - Linux | ||
| - type: textarea | ||
| id: logs | ||
| attributes: | ||
| label: Relevant log output | ||
| description: | | ||
| Please copy and paste any relevant log output. | ||
| This will be automatically formatted into code, so no need for backticks. | ||
| render: raw | ||
| - type: checkboxes | ||
| id: terms | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our [Code of Conduct](../CODE_OF_CONDUCT.md) | ||
| options: | ||
| - label: I agree to follow this project's Code of Conduct | ||
| required: true | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: ❓ Ask a question about this project | ||
| url: https://github.com/bitwizeshift/alloy-rs/discussions/categories/q-a | ||
| about: Please ask and/or answer questions about this project here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| name: Feature Request | ||
| description: 💡 Create a feature request | ||
| title: "[Feature Request]: " | ||
| labels: ["feature-request", "triage"] | ||
| assignees: | ||
| - bitwizeshift | ||
|
|
||
|
|
||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thank you for taking the time to suggest improvements for this project! | ||
| Before submitting a feature request, we encourage you to discuss your | ||
| idea with the community. Open a discussion in our | ||
| [community forum](https://github.com/bitwizeshift/alloy-rs/discussions) | ||
| to get feedback and gather support for your feature. | ||
| Please search for existing discussions to avoid duplication. If there is | ||
| already a similar request, consider adding your thoughts and votes to the | ||
| existing thread. | ||
| - type: input | ||
| id: feature-title | ||
| attributes: | ||
| label: Feature Title | ||
| description: A clear and concise title for your feature request. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: feature-description | ||
| attributes: | ||
| label: Feature Description | ||
| description: | | ||
| Provide a detailed description of the feature you are proposing. | ||
| Include any relevant use cases, scenarios, or examples. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: input | ||
| id: use-case | ||
| attributes: | ||
| label: Use Case | ||
| description: | | ||
| Describe a specific use case or scenario where this feature would be | ||
| beneficial. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: input | ||
| id: benefits | ||
| attributes: | ||
| label: Benefits | ||
| description: | | ||
| Explain the benefits of implementing this feature. How will it enhance | ||
| the overall user experience or contribute to the project's goals? | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: alternatives | ||
| attributes: | ||
| label: Alternatives Considered | ||
| description: | | ||
| Have you considered any alternative solutions or workarounds? | ||
| If so, please describe them. | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: input | ||
| id: additional-info | ||
| attributes: | ||
| label: Additional Information | ||
| description: | | ||
| Provide any additional information, links, or resources that may be | ||
| relevant to your feature request. | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: checkboxes | ||
| id: terms | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our [Code of Conduct](../CODE_OF_CONDUCT.md) | ||
| options: | ||
| - label: I agree to follow this project's Code of Conduct | ||
| required: true | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| name: Security Vulnerability report | ||
| description: 🔐 File a Security Vulnerability report | ||
| title: "[Security]: " | ||
| labels: ["security", "triage"] | ||
| assignees: | ||
| - bitwizeshift | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: Thank you for taking the time to fill out this vulnerability report! | ||
| - type: dropdown | ||
| id: systems | ||
| attributes: | ||
| label: What systems are affected by this vulnerability? | ||
| multiple: true | ||
| options: | ||
| - macOS | ||
| - Windows | ||
| - Linux | ||
| - type: textarea | ||
| id: what-vulnerability | ||
| attributes: | ||
| label: What is the vulnerability you discvoered? | ||
| description: Please describe what the vulnerability is | ||
| placeholder: What did you experience? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: steps-to-reproduce | ||
| attributes: | ||
| label: Steps to Reproduce | ||
| description: How do you trigger this vulnerability? Please walk us through it step by step. | ||
| placeholder: | | ||
| 1. | ||
| 2. | ||
| 3. | ||
| ... | ||
| render: bash | ||
| - type: textarea | ||
| id: vulnerability-description | ||
| attributes: | ||
| label: How might this vulnerability be applied? | ||
| description: | | ||
| Please describe how a bad-actor might leverage this vulnerability. | ||
| What is the worst-case scenario? | ||
| - type: textarea | ||
| id: logs | ||
| attributes: | ||
| label: Relevant log output | ||
| description: | | ||
| Please copy and paste any relevant log output. | ||
| This will be automatically formatted into code, so no need for backticks. | ||
| render: raw | ||
| - type: checkboxes | ||
| id: terms | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our [Code of Conduct](../CODE_OF_CONDUCT.md) | ||
| options: | ||
| - label: I agree to follow this project's Code of Conduct | ||
| required: true | ||
|
|