From c7b05024ed0ac539163c1499e26fe97f06ec3332 Mon Sep 17 00:00:00 2001 From: Martijn van Dijk Date: Sat, 3 Aug 2024 16:15:28 +0200 Subject: [PATCH] Templates --- .github/ISSUE_TEMPLATE/bug.yaml | 96 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/documentation.yaml | 28 +++++++ .github/ISSUE_TEMPLATE/feature.yaml | 37 +++++++++ .github/dependabot.yaml | 11 +++ 4 files changed, 172 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yaml create mode 100644 .github/ISSUE_TEMPLATE/documentation.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature.yaml create mode 100644 .github/dependabot.yaml diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml new file mode 100644 index 0000000..2b0d266 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -0,0 +1,96 @@ +name: 🐛 Bug +description: Something is crashing or not working as intended +title: "[Field name or General]: " +labels: [bug] +body: +- type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true +- type: input + attributes: + label: Package/Plugin version + description: Version number + placeholder: '1.0.0' + validations: + required: true +- type: checkboxes + attributes: + label: Platforms + description: Please select in whats platform you tested this bug. + options: + - label: Android + - label: iOS + - label: Linux + - label: MacOS + - label: Web + - label: Windows +- type: textarea + attributes: + label: Flutter doctor + description: Paste the output of running `flutter doctor -v` + value: | + <details> + <summary>Flutter doctor</summary> + + <!-- Paste the output below inside ``` and ``` --> + ```bash + + ``` + + </details> + validations: + required: true +- type: textarea + attributes: + label: Minimal code example + description: | + Create a minimal code example to reproduce the issue. + Try to not use external packages not related with flutter form builder ecosystem + Without this we will unlikely be able to progress on the issue, and because of that + we regretfully will have to close it. + value: | + <details> + <summary>Code sample</summary> + + <!-- Paste the output below inside ``` and ``` --> + + ```dart + + ``` + + </details> + validations: + required: true +- type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: true +- type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: true +- type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + validations: + required: true +- type: textarea + attributes: + label: Aditional information + placeholder: Can add images, videos, more context, etc. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/documentation.yaml b/.github/ISSUE_TEMPLATE/documentation.yaml new file mode 100644 index 0000000..12539ae --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yaml @@ -0,0 +1,28 @@ +name: 📘 Documentation +description: You want to report something that is wrong or missing from the documentation +labels: [documentation] +body: +- type: textarea + attributes: + label: Describe the change you would like to see + placeholder: | + A clear and concise description of the bug or documentation you feel is missing. + For example: The Technical Reference does not include information about the FormBuilderFilterChip widget. + render: Markdown + validations: + required: true +- type: textarea + attributes: + label: How would the suggested change make the documentation more useful? + placeholder: | + Provide context for how the requested change would make the docs easier to use and improve your ability to develop successful applications with this packages. + For example: It's hard to know a method exists or understand its use when you have to search through the code base to learn about it. Properly documenting it in the Technical Reference makes it easier for me to know what the flutter_fom_builder is (and is not capable of). + render: Markdown + validations: + required: false +- type: textarea + attributes: + label: Aditional information + placeholder: Can add images, videos, more context, etc. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature.yaml b/.github/ISSUE_TEMPLATE/feature.yaml new file mode 100644 index 0000000..a827e18 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yaml @@ -0,0 +1,37 @@ +name: 🚀 Feature request +description: Suggest new feature or request for this project +title: "[Field name or General]: <title>" +labels: [enhancement] +body: +- type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the feature you requested. + options: + - label: I have searched the existing issues + required: true +- type: input + attributes: + label: Package/Plugin version + description: Version number + placeholder: '1.0.0' + validations: + required: true +- type: textarea + attributes: + label: What you'd like to happen + render: Markdown + validations: + required: true +- type: textarea + attributes: + label: Alternatives you've considered + render: Markdown + validations: + required: false +- type: textarea + attributes: + label: Aditional information + placeholder: Can add images, videos, more context, etc. + validations: + required: false \ No newline at end of file diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml new file mode 100644 index 0000000..a771f5a --- /dev/null +++ b/.github/dependabot.yaml @@ -0,0 +1,11 @@ +version: 2 +enable-beta-ecosystems: true +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "daily" + - package-ecosystem: "pub" + directory: "/" + schedule: + interval: "daily" \ No newline at end of file