diff --git a/.github/ISSUE_TEMPLATE/1_bug.yml b/.github/ISSUE_TEMPLATE/1_bug.yml index cb20aeec9..b859a4076 100644 --- a/.github/ISSUE_TEMPLATE/1_bug.yml +++ b/.github/ISSUE_TEMPLATE/1_bug.yml @@ -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. ... @@ -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 @@ -57,15 +58,14 @@ body:
Screenshots / Video demonstration - [Upload media here] + [Attach media here]
-
Logs ```console - [Paste your logs here] + [Paste logs here] ```
diff --git a/.github/ISSUE_TEMPLATE/2_feature_request.yml b/.github/ISSUE_TEMPLATE/2_feature_request.yml index 26100b3da..d20e75e7c 100644 --- a/.github/ISSUE_TEMPLATE/2_feature_request.yml +++ b/.github/ISSUE_TEMPLATE/2_feature_request.yml @@ -1,16 +1,16 @@ 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 @@ -18,24 +18,19 @@ body: 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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/3_question.yml b/.github/ISSUE_TEMPLATE/3_question.yml deleted file mode 100644 index fc462fc0b..000000000 --- a/.github/ISSUE_TEMPLATE/3_question.yml +++ /dev/null @@ -1,24 +0,0 @@ -name: Ask a question -description: | - If you have any questions, feel free to ask -labels: 'question' -body: - - type: markdown - attributes: - value: | - If you have any suggestions or questions, feel free to share them in the [Discussions](https://github.com/singerdmx/flutter-quill/discussions) section. - - - type: checkboxes - attributes: - label: Is there an existing issue for this? - options: - - label: I have searched the [existing issues](https://github.com/singerdmx/flutter-quill/issues) - required: true - - type: textarea - attributes: - label: The question - description: Please explain your question here - placeholder: | - How do I save the images of Quill Editor? - validations: - required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 0086358db..754693625 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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.