From 70c7bb97dc5caab1ca8e1975159f161e6962ccd4 Mon Sep 17 00:00:00 2001 From: Ellet <73608287+freshtechtips@users.noreply.github.com> Date: Thu, 9 Nov 2023 00:22:43 +0300 Subject: [PATCH] Add new github workflows --- .github/ISSUE_TEMPLATE/1_bug.yml | 114 +++++++++++++++++++ .github/ISSUE_TEMPLATE/2_feature_request.yml | 41 +++++++ .github/workflows/welcome.yml | 18 +++ packages/README.md | 6 + 4 files changed, 179 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/1_bug.yml create mode 100644 .github/ISSUE_TEMPLATE/2_feature_request.yml create mode 100644 .github/workflows/welcome.yml create mode 100644 packages/README.md diff --git a/.github/ISSUE_TEMPLATE/1_bug.yml b/.github/ISSUE_TEMPLATE/1_bug.yml new file mode 100644 index 00000000..8826b00c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_bug.yml @@ -0,0 +1,114 @@ +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. +labels: 'bug' +body: + - type: markdown + attributes: + value: | + Thank you for using Flutter Quill! + + - 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: Steps to reproduce + description: Please tell us exactly how to reproduce the problem you are running into. + placeholder: | + 1. ... + 2. ... + 3. ... + validations: + required: true + - type: textarea + attributes: + label: Expected results + description: Please tell us what is expected to happen. + validations: + required: true + - type: textarea + attributes: + label: Actual results + description: Please tell us what is actually happening. + validations: + required: true + - type: textarea + attributes: + label: Code sample + description: | + Please create a minimal reproducible sample that shows the problem + and attach it below between the lines with the backticks. + + To create it, use the `flutter create bug` command and update the `main.dart` file. + + Alternatively, you can use https://dartpad.dev/ or create a public GitHub + repository to share your sample. + + Note: Please do not upload screenshots of text. Instead, use code blocks + or the above mentioned ways to upload your code sample. + value: | +
Code sample + + ```dart + [Paste your code here] + ``` + +
+ validations: + required: true + - type: textarea + attributes: + label: Screenshots or Video + description: | + Upload any screenshots or video of the bug if applicable. + value: | +
+ Screenshots / Video demonstration + + [Upload media here] + +
+ - type: textarea + attributes: + label: Logs + description: | + Include the full logs of the commands you are running between the lines + with the backticks below. If you are running any `flutter` commands, + please include the output of running them with `--verbose`; for example, + the output of running `flutter --verbose create foo`. + + 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 + share it. + + Note: Please do not upload screenshots of text. Instead, use code blocks + or the above mentioned ways to upload logs. + value: | +
Logs + + ```console + [Paste your logs here] + ``` + +
+ - type: textarea + attributes: + label: Flutter Doctor output (optional) + description: | + Please provide the full output of running `flutter doctor -v` + if the issue is related on how the library use the Flutter Quill + value: | +
Doctor output + + ```console + [Paste your output here] + ``` + +
+ # validations: + # required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/2_feature_request.yml b/.github/ISSUE_TEMPLATE/2_feature_request.yml new file mode 100644 index 00000000..26100b3d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2_feature_request.yml @@ -0,0 +1,41 @@ +name: Feature request +description: Suggest a new idea for Flutter Quill. +labels: 'enhancement' +body: + - type: markdown + attributes: + value: | + Thank you for using Flutter Quill! + + - 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. + 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? + validations: + required: true + - type: textarea + attributes: + label: Proposal + description: | + Briefly but precisely describe what you would like Flutter Quill to be able to do. + + Consider attaching something showing what you are imagining: + * images + * videos + * code samples + validations: + required: true \ No newline at end of file diff --git a/.github/workflows/welcome.yml b/.github/workflows/welcome.yml new file mode 100644 index 00000000..5d47fe9a --- /dev/null +++ b/.github/workflows/welcome.yml @@ -0,0 +1,18 @@ +name: 'Welcome New Contributors' + +on: + issues: + types: [opened] + pull_request_target: + types: [opened] + +jobs: + welcome-new-contributor: + runs-on: ubuntu-latest + steps: + - name: 'Greet the contributor' + uses: garg3133/welcome-new-contributors@v1.2 + with: + token: ${{ secrets.GITHUB_TOKEN }} + issue-message: 'Hello there, on behalf the Flutter Quill Team I would like to thank you for opening your first issue. Your inputs and insights are valuable in shaping a stable and reliable version for all our users. Thank you for being part of the open-source community!' + pr-message: 'Hi there, thanks for opening your first Pull Request to this project!!' \ No newline at end of file diff --git a/packages/README.md b/packages/README.md new file mode 100644 index 00000000..6da077ab --- /dev/null +++ b/packages/README.md @@ -0,0 +1,6 @@ +# Flutter Quill Packages + +This folder contains packages that add more features to the [FlutterQuill](../README.md) +that might be outside of the packages main purpose + +This page will be updated soon. \ No newline at end of file