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.

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

chore: improve bug and feature request GitHub issue templates #2444

Merged
merged 1 commit into from
Jan 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 16 additions & 16 deletions .github/ISSUE_TEMPLATE/1_bug.yml
Original file line number Diff line number Diff line change
@@ -1,31 +1,30 @@
name: Report a bug
description: |
You found a bug in Flutter Quill causing your application to crash or
throw an exception, a widget is buggy, unexpected behavior or something looks wrong.
description: Report issues with Flutter Quill, including crashes, exceptions, buggy widgets, or unexpected behavior.
labels: 'bug'
body:
- type: markdown
attributes:
value: |
Thank you for using Flutter Quill!
Please provide the following details to help us address your issue effectively.

- type: checkboxes
attributes:
label: Is there an existing issue for this?
label: Have you checked for an existing issue?
description: Ensure there isn’t already an open issue for this feature request.
options:
- label: I have searched the [existing issues](https://github.com/singerdmx/flutter-quill/issues)
required: true
- type: input
attributes:
label: Flutter Quill version
description: The version of the project for the packages (e.g., `flutter_quill` and `flutter_quill_extensions`)
placeholder: (e.g., 10.0.0)
label: Flutter Quill Version
description: The relevant package versions
placeholder: e.g., 10.0.0
validations:
required: false
- type: textarea
attributes:
label: Steps to reproduce
description: Please tell us exactly how to reproduce the problem you are running into.
label: Steps to Reproduce
description: Provide a clear step-by-step guide to reproduce the issue.
placeholder: |
1. ...
2. ...
Expand All @@ -35,20 +34,22 @@ body:
- type: textarea
attributes:
label: Expected results
description: Please tell us what is expected to happen.
description: Describe what you expected to happen.
validations:
required: true
- type: textarea
attributes:
label: Actual results
description: Please tell us what is actually happening.
description: Describe what is happening instead of the expected behavior.
validations:
required: true
- type: textarea
attributes:
label: Additional Context
description: |
Include additional information such as Screenshots or Logs if needed.
Add any extra information such as screenshots, videos, or logs to help diagnose the issue.

Consider sharing the `pubspec.lock` file of the project if relevant.

If the logs are too large to be uploaded to GitHub, you may upload
them as a `txt` file or use online tools like https://pastebin.com to
Expand All @@ -57,15 +58,14 @@ body:
<details>
<summary>Screenshots / Video demonstration</summary>

[Upload media here]
[Attach media here]

</details>


<details><summary>Logs</summary>

```console
[Paste your logs here]
[Paste logs here]
```

</details>
Expand Down
27 changes: 11 additions & 16 deletions .github/ISSUE_TEMPLATE/2_feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,41 +1,36 @@
name: Feature request
description: Suggest a new idea for Flutter Quill.
description: Propose a new idea or enhancement for Flutter Quill.
labels: 'enhancement'
body:
- type: markdown
attributes:
value: |
Thank you for using Flutter Quill!
Please provide the following details to help us evaluate your feature request.

- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for this feature request or proposal.
label: Have you checked for an existing issue?
description: Ensure there isn’t already an open issue for this feature request.
options:
- label: I have searched the [existing issues](https://github.com/singerdmx/flutter-quill/issues)
required: true
- type: textarea
attributes:
label: Use case
description: |
Please tell us the problem you are running into that led to you wanting
a new feature.

Is your feature request related to a problem? Please give a clear and
concise description of what the problem is.

Describe the alternative solutions you've considered. Is there already a solution that solves this?
Describe the problem or challenge that led to this feature request.
Include any alternative solutions you’ve considered and why they don’t work.
validations:
required: true
- type: textarea
attributes:
label: Proposal
description: |
Briefly but precisely describe what you would like Flutter Quill to be able to do.
Describe your proposed solution and what you’d like Flutter Quill to do.

Consider attaching something showing what you are imagining:
* images
* videos
* code samples
You can include additional resources such as:
- Images
- Videos
- Code samples
validations:
required: true
24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE/3_question.yml

This file was deleted.

4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Community Support
url: https://github.com/singerdmx/flutter-quill/discussions/new?category=q-a
about: Ask a question about using the package.
Loading