Skip to content

Commit 8d46514

Browse files
authored
chore: improve bug and feature request GitHub issue templates, replace question issue template with GitHub discussions (#2444)
1 parent 46b3662 commit 8d46514

File tree

4 files changed

+31
-56
lines changed

4 files changed

+31
-56
lines changed

.github/ISSUE_TEMPLATE/1_bug.yml

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,30 @@
11
name: Report a bug
2-
description: |
3-
You found a bug in Flutter Quill causing your application to crash or
4-
throw an exception, a widget is buggy, unexpected behavior or something looks wrong.
2+
description: Report issues with Flutter Quill, including crashes, exceptions, buggy widgets, or unexpected behavior.
53
labels: 'bug'
64
body:
75
- type: markdown
86
attributes:
97
value: |
10-
Thank you for using Flutter Quill!
8+
Please provide the following details to help us address your issue effectively.
119
1210
- type: checkboxes
1311
attributes:
14-
label: Is there an existing issue for this?
12+
label: Have you checked for an existing issue?
13+
description: Ensure there isn’t already an open issue for this feature request.
1514
options:
1615
- label: I have searched the [existing issues](https://github.com/singerdmx/flutter-quill/issues)
1716
required: true
1817
- type: input
1918
attributes:
20-
label: Flutter Quill version
21-
description: The version of the project for the packages (e.g., `flutter_quill` and `flutter_quill_extensions`)
22-
placeholder: (e.g., 10.0.0)
19+
label: Flutter Quill Version
20+
description: The relevant package versions
21+
placeholder: e.g., 10.0.0
2322
validations:
2423
required: false
2524
- type: textarea
2625
attributes:
27-
label: Steps to reproduce
28-
description: Please tell us exactly how to reproduce the problem you are running into.
26+
label: Steps to Reproduce
27+
description: Provide a clear step-by-step guide to reproduce the issue.
2928
placeholder: |
3029
1. ...
3130
2. ...
@@ -35,20 +34,22 @@ body:
3534
- type: textarea
3635
attributes:
3736
label: Expected results
38-
description: Please tell us what is expected to happen.
37+
description: Describe what you expected to happen.
3938
validations:
4039
required: true
4140
- type: textarea
4241
attributes:
4342
label: Actual results
44-
description: Please tell us what is actually happening.
43+
description: Describe what is happening instead of the expected behavior.
4544
validations:
4645
required: true
4746
- type: textarea
4847
attributes:
4948
label: Additional Context
5049
description: |
51-
Include additional information such as Screenshots or Logs if needed.
50+
Add any extra information such as screenshots, videos, or logs to help diagnose the issue.
51+
52+
Consider sharing the `pubspec.lock` file of the project if relevant.
5253
5354
If the logs are too large to be uploaded to GitHub, you may upload
5455
them as a `txt` file or use online tools like https://pastebin.com to
@@ -57,15 +58,14 @@ body:
5758
<details>
5859
<summary>Screenshots / Video demonstration</summary>
5960
60-
[Upload media here]
61+
[Attach media here]
6162
6263
</details>
6364
64-
6565
<details><summary>Logs</summary>
6666
6767
```console
68-
[Paste your logs here]
68+
[Paste logs here]
6969
```
7070
7171
</details>
Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,36 @@
11
name: Feature request
2-
description: Suggest a new idea for Flutter Quill.
2+
description: Propose a new idea or enhancement for Flutter Quill.
33
labels: 'enhancement'
44
body:
55
- type: markdown
66
attributes:
77
value: |
8-
Thank you for using Flutter Quill!
8+
Please provide the following details to help us evaluate your feature request.
99
1010
- type: checkboxes
1111
attributes:
12-
label: Is there an existing issue for this?
13-
description: Please search to see if an issue already exists for this feature request or proposal.
12+
label: Have you checked for an existing issue?
13+
description: Ensure there isn’t already an open issue for this feature request.
1414
options:
1515
- label: I have searched the [existing issues](https://github.com/singerdmx/flutter-quill/issues)
1616
required: true
1717
- type: textarea
1818
attributes:
1919
label: Use case
2020
description: |
21-
Please tell us the problem you are running into that led to you wanting
22-
a new feature.
23-
24-
Is your feature request related to a problem? Please give a clear and
25-
concise description of what the problem is.
26-
27-
Describe the alternative solutions you've considered. Is there already a solution that solves this?
21+
Describe the problem or challenge that led to this feature request.
22+
Include any alternative solutions you’ve considered and why they don’t work.
2823
validations:
2924
required: true
3025
- type: textarea
3126
attributes:
3227
label: Proposal
3328
description: |
34-
Briefly but precisely describe what you would like Flutter Quill to be able to do.
29+
Describe your proposed solution and what you’d like Flutter Quill to do.
3530
36-
Consider attaching something showing what you are imagining:
37-
* images
38-
* videos
39-
* code samples
31+
You can include additional resources such as:
32+
- Images
33+
- Videos
34+
- Code samples
4035
validations:
4136
required: true

.github/ISSUE_TEMPLATE/3_question.yml

Lines changed: 0 additions & 24 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
11
blank_issues_enabled: true
2+
contact_links:
3+
- name: Community Support
4+
url: https://github.com/singerdmx/flutter-quill/discussions/new?category=q-a
5+
about: Ask a question about using the package.

0 commit comments

Comments
 (0)