Skip to content

Commit

Permalink
chore: issue forms with reason-listings (#3476)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
CommanderStorm and abonander authored Jan 4, 2025
1 parent 28cfdbb commit 9d74aea
Show file tree
Hide file tree
Showing 4 changed files with 98 additions and 39 deletions.
19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -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 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -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?

0 comments on commit 9d74aea

Please sign in to comment.