chore: issue forms with reason-listings (#3476)
* feat: added a draft of an issue form * fixed a validation issue * finished up the templates * used austins phrasing * Applied comments from the code review Co-authored-by: Austin Bonander <austin.bonander@gmail.com> * Applyed more suggestions from code review Co-authored-by: Austin Bonander <austin.bonander@gmail.com> * Broke the environment up into multiple fields * boiled the FR-fields down to a description and an breaking change field * fixed an unique id issue --------- Co-authored-by: Austin Bonander <austin.bonander@gmail.com>
This commit is contained in:
parent
28cfdbb40c
commit
9d74aeae52
4 changed files with 98 additions and 39 deletions
19
.github/ISSUE_TEMPLATE/bug_report.md
vendored
19
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
@ -1,19 +0,0 @@
|
|||
---
|
||||
name: I think I found a bug in SQLx
|
||||
about: Create a bug-report issue.
|
||||
title: ''
|
||||
labels: 'bug'
|
||||
assignees: ''
|
||||
---
|
||||
### Bug Description
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
### Minimal Reproduction
|
||||
A small code snippet or a link to a Github repo or Gist, with instructions on reproducing the bug.
|
||||
|
||||
### Info
|
||||
* SQLx version: [REQUIRED]
|
||||
* SQLx features enabled: [REQUIRED]
|
||||
* Database server and version: [REQUIRED] (MySQL / Postgres / SQLite <x.y.z>)
|
||||
* Operating system: [REQUIRED]
|
||||
* `rustc --version`: [REQUIRED]
|
61
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
61
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
|
@ -0,0 +1,61 @@
|
|||
name: I think I found a bug in SQLx
|
||||
description: Create a bug-report issue
|
||||
labels: [bug]
|
||||
body:
|
||||
- type: textarea
|
||||
id: related-issues
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: I have found these related issues/pull requests
|
||||
description: |
|
||||
I have searched by clicking [HERE](https://github.com/launchbadge/sqlx/issues?q=)
|
||||
for existing issues, these are the ones I've found,
|
||||
and this is why I think this deserves a new issue.
|
||||
placeholder: "Related to ..."
|
||||
- type: textarea
|
||||
id: description
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Description
|
||||
description: Clear and concise description of what the bug is
|
||||
- type: textarea
|
||||
id: steps-to-reproduce
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Reproduction steps
|
||||
description: A small code snippet or a link to a Github repo or Gist, with instructions on reproducing the bug.
|
||||
- type: input
|
||||
id: sqlx-version
|
||||
attributes:
|
||||
label: SQLx version
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: sqlx-features
|
||||
attributes:
|
||||
label: Enabled SQLx features
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: db-server-and-version
|
||||
attributes:
|
||||
label: Database server and version
|
||||
placeholder: MySQL / Postgres / SQLite <x.y.z>
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: os-type
|
||||
attributes:
|
||||
label: Operating system
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: rust-version
|
||||
attributes:
|
||||
label: Rust version
|
||||
description: You can get this via running `rustc --version`
|
||||
validations:
|
||||
required: true
|
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
|
@ -1,20 +0,0 @@
|
|||
---
|
||||
name: I have a feature request for SQLx
|
||||
about: Create a feature-request issue.
|
||||
title: ''
|
||||
labels: 'enhancement'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
37
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
37
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
|
@ -0,0 +1,37 @@
|
|||
name: I have a feature request for SQLx
|
||||
description: Create a feature-request issue
|
||||
labels: [enhancement]
|
||||
body:
|
||||
- type: textarea
|
||||
id: related-issues
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: I have found these related issues/pull requests
|
||||
description: "Provide context for your pull request."
|
||||
placeholder: |
|
||||
Closes \#...
|
||||
Relates to \#...
|
||||
- type: textarea
|
||||
id: feature-description
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Description
|
||||
description: A clear and concise description of what the problem is
|
||||
placeholder: You should add ...
|
||||
- type: textarea
|
||||
id: solution
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Prefered solution
|
||||
description: A clear and concise description of what you want to happen.
|
||||
placeholder: In my use-case, ...
|
||||
- type: textarea
|
||||
id: breaking-change
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Is this a breaking change? Why or why not?
|
||||
|
Loading…
Add table
Reference in a new issue