Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: issue forms with reason-listings #3476

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

chore: issue forms with reason-listings #3476

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
1a872f7
feat: added a draft of an issue form
CommanderStorm Aug 31, 2024
49eb1ad
fixed a validation issue
CommanderStorm Aug 31, 2024
47dbf4f
finished up the templates
CommanderStorm Aug 31, 2024
4c99b00
used austins phrasing
CommanderStorm Aug 31, 2024
7d23826
Applied comments from the code review
CommanderStorm Sep 22, 2024
df09d24
Applyed more suggestions from code review
CommanderStorm Sep 22, 2024
3f47691
Broke the environment up into multiple fields
CommanderStorm Sep 23, 2024
83d27b3
boiled the FR-fields down to a description and an breaking change field
CommanderStorm Sep 23, 2024
d2c94d7
fixed an unique id issue
CommanderStorm Sep 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop

This file was deleted.

38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
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."
CommanderStorm marked this conversation as resolved.
Show resolved Hide resolved
placeholder: "Related to #1 by also touching the ... system. They should not be merged because ..."
CommanderStorm marked this conversation as resolved.
Show resolved Hide resolved
- 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: textarea
id: deployment-info
attributes:
label: Environment Information
value: |
* SQLx version: [REQUIRED]
* SQLx features enabled: [REQUIRED]
* Database server and version: [REQUIRED] (MySQL / Postgres / SQLite <x.y.z>)
* Operating system: [REQUIRED]
* `rustc --version`: [REQUIRED]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might as well break these out into separate fields.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair enough.
This has the downside of looking a bit longer in the issue that is genereated, but that is likely an ok downside

validations:
required: true
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md
View file
Open in desktop

This file was deleted.

44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
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: "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."
CommanderStorm marked this conversation as resolved.
Show resolved Hide resolved
placeholder: "Related to #1 by also touching the ... system. They should not be merged because ..."
CommanderStorm marked this conversation as resolved.
Show resolved Hide resolved
- 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: alternatives
validations:
required: false
attributes:
label: Alternative solutions
description: A clear and concise description of any alternative solutions or features you've considered
placeholder: I have considered ...
CommanderStorm marked this conversation as resolved.
Show resolved Hide resolved
- type: textarea
id: additional-context
validations:
required: false
attributes:
label: Additional Context
description: Add any other context or screenshots about the feature request here
placeholder: ...
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What maybe would be nice is a field where they list some relevant areas (e.g. mysql, postgres, macros, etc).

Also, "is this a breaking change? why or why not?"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unsure about the wording on this one. We maybe need to iterate on the wording a bit.

What kind of answers would you like to this question?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And should this field be mandatory?