Bug report 2 issue template (#122385)

Bug report 2 issue template
2023-04-12 16:36:16 +05:30 · 2023-04-12 16:36:16 +05:30 · 6d01ae1377
commit 6d01ae1377
parent e21c149b99
9 changed files with 138 additions and 108 deletions
--- a/.github/ISSUE_TEMPLATE/2_bug.md
+++ b/.github/ISSUE_TEMPLATE/2_bug.md
@ -1,93 +0,0 @@
---
-name: I have a problem with my Flutter application.
-about: You are writing an application with Flutter but the application is crashing
-  or throws an exception, a widget is buggy, or something looks wrong.
-title: ''
-labels: ''
-assignees: ''
-
---
-
-<!-- Thank you for using Flutter!
-
-     If you are looking for support, please check out our documentation
-     or consider asking a question on Stack Overflow:
-      * https://flutter.dev/
-      * https://api.flutter.dev/
-      * https://stackoverflow.com/questions/tagged/flutter?sort=frequent
-
-     If you have found a bug or if our documentation doesn't have an answer
-     to what you're looking for, then fill out the template below. Please read
-     our guide to filing a bug first: https://flutter.dev/docs/resources/bug-reports
-->
-
-## Steps to Reproduce
-
-<!-- Please include full steps to reproduce so that we can reproduce the problem. -->
-
-1. Execute `flutter run` on the code sample <!-- (see "Code sample" section below) -->
-2. ... <!-- describe steps to demonstrate bug -->
-3. ... <!-- for example "Tap on X and see a crash" -->
-
-**Expected results:** <!-- what did you want to see? -->
-
-**Actual results:** <!-- what did you see? -->
-
-<details>
-<summary>Code sample</summary>
-
-<!--
-      Please create a minimal reproducible sample that shows the problem
-      and attach it below between the lines with the backticks.
-
-      To create it you can use `flutter create bug` command and update the `main.dart` file.
-
-      Alternatively, you can use https://dartpad.dev/
-      which is capable of creating and running small Flutter apps.
-
-      Without this we will unlikely be able to progress on the issue, and because of that
-      we regretfully will have to close it.
-->
-
-```dart
-```
-
-</details>
-
-<details>
-  <summary>Logs</summary>
-
-<!--
-      Run your application with `flutter run --verbose` and attach all the
-      log output below between the lines with the backticks. If there is an
-      exception, please see if the error message includes enough information
-      to explain how to solve the issue. If there is a crash, please include
-      the entirety of the crash log including the backtrace.
-->
-
-```
-```
-
-<!--
-     Run `flutter analyze` and attach any output of that command below.
-     If there are any analysis errors, try resolving them before filing this issue.
-->
-
-```
-```
-
-<!-- Finally, paste the output of running `flutter doctor -v` here. -->
-
-```
-```
-
-</details>
-
-
-<!--
-      Consider also attaching screenshots and/or videos to better
-      illustrate the issue.
-
-      You can upload them directly on GitHub.
-      Beware that video file size is limited to 10MB.
-->
--- a/.github/ISSUE_TEMPLATE/2_bug.yml
+++ b/.github/ISSUE_TEMPLATE/2_bug.yml
@ -0,0 +1,123 @@
+name: Report a bug
+description: |
+  You found a bug in Flutter causing your application to crash or
+  throw an exception, a widget is buggy, or something looks wrong.
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for using Flutter!
+
+        If you are looking for support, please check out our documentation
+        or consider asking a question on Stack Overflow:
+
+          - https://flutter.dev/
+          - https://api.flutter.dev/
+          - https://stackoverflow.com/questions/tagged/flutter?sort=frequent
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this?
+      options:
+      - label: I have searched the [existing issues](https://github.com/flutter/flutter/issues)
+        required: true
+      - label: I have read the [guide to filing a bug](https://flutter.dev/docs/resources/bug-reports)
+        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.
+
+        Without this we will unlikely be able to progress on the issue, and because of that
+        we regretfully will have to close it.
+
+        Note: Please do not upload screenshots of text. Instead, use code blocks
+        or the above mentioned ways to upload your code sample.
+      value: |
+        <details><summary>Code sample</summary>
+
+        ```dart
+        [Paste your code here]
+        ```
+
+        </details>
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Screenshots or Video
+      description: |
+        Upload any screenshots or video of the bug if applicable.
+      value: |
+        <details>
+        <summary>Screenshots / Video demonstration</summary>
+
+        [Upload media here]
+
+        </details>
+  - 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: |
+        <details><summary>Logs</summary>
+
+        ```console
+        [Paste your logs here]
+        ```
+
+        </details>
+  - type: textarea
+    attributes:
+      label: Flutter Doctor output
+      description: |
+        Please provide the full output of running `flutter doctor -v`
+      value: |
+        <details><summary>Doctor output</summary>
+
+        ```console
+        [Paste your output here]
+        ```
+
+        </details>
+    validations:
+      required: true
--- a/packages/flutter/lib/src/foundation/assertions.dart
+++ b/packages/flutter/lib/src/foundation/assertions.dart
@ -724,7 +724,7 @@ class FlutterErrorDetails with Diagnosticable {
            'provide substantially more information in this error message to help you determine '
            'and fix the underlying cause.\n'
            'In either case, please report this assertion by filing a bug on GitHub:\n'
-            '  https://github.com/flutter/flutter/issues/new?template=2_bug.md',
+            '  https://github.com/flutter/flutter/issues/new?template=2_bug.yml',
          ));
        }
      }
@ -857,7 +857,7 @@ class FlutterError extends Error with DiagnosticableTreeMixin implements Asserti
          '\nThis error should still help you solve your problem, '
          'however please also report this malformed error in the '
          'framework by filing a bug on GitHub:\n'
-          '  https://github.com/flutter/flutter/issues/new?template=2_bug.md',
+          '  https://github.com/flutter/flutter/issues/new?template=2_bug.yml',
        ),
      ]),
    );
@ -883,7 +883,7 @@ class FlutterError extends Error with DiagnosticableTreeMixin implements Asserti
          '\nThis error should still help you solve your problem, '
          'however please also report this malformed error in the '
          'framework by filing a bug on GitHub:\n'
-          '  https://github.com/flutter/flutter/issues/new?template=2_bug.md',
+          '  https://github.com/flutter/flutter/issues/new?template=2_bug.yml',
        ));
        throw FlutterError.fromParts(message);
      }
--- a/packages/flutter/lib/src/rendering/box.dart
+++ b/packages/flutter/lib/src/rendering/box.dart
@ -1906,7 +1906,7 @@ abstract class RenderBox extends RenderObject {
        ErrorSummary('The ${objectRuntimeType(this, 'RenderBox')} class does not implement "computeDryLayout".'),
        ErrorHint(
          'If you are not writing your own RenderBox subclass, then this is not\n'
-          'your fault. Contact support: https://github.com/flutter/flutter/issues/new?template=2_bug.md',
+          'your fault. Contact support: https://github.com/flutter/flutter/issues/new?template=2_bug.yml',
        ),
      ]),
    ));
@ -2266,7 +2266,7 @@ abstract class RenderBox extends RenderObject {
          DiagnosticsProperty<Size>('Size', _size, style: DiagnosticsTreeStyle.errorProperty),
          ErrorHint(
            'If you are not writing your own RenderBox subclass, then this is not '
-            'your fault. Contact support: https://github.com/flutter/flutter/issues/new?template=2_bug.md',
+            'your fault. Contact support: https://github.com/flutter/flutter/issues/new?template=2_bug.yml',
          ),
        ]);
      }
@ -2315,7 +2315,7 @@ abstract class RenderBox extends RenderObject {
            ...failures,
            ErrorHint(
              'If you are not writing your own RenderBox subclass, then this is not\n'
-              'your fault. Contact support: https://github.com/flutter/flutter/issues/new?template=2_bug.md',
+              'your fault. Contact support: https://github.com/flutter/flutter/issues/new?template=2_bug.yml',
            ),
          ]);
        }
@ -2341,7 +2341,7 @@ abstract class RenderBox extends RenderObject {
            ),
            ErrorHint(
              'If you are not writing your own RenderBox subclass, then this is not\n'
-              'your fault. Contact support: https://github.com/flutter/flutter/issues/new?template=2_bug.md',
+              'your fault. Contact support: https://github.com/flutter/flutter/issues/new?template=2_bug.yml',
            ),
          ]);
        }
--- a/packages/flutter/lib/src/rendering/flex.dart
+++ b/packages/flutter/lib/src/rendering/flex.dart
@ -758,7 +758,7 @@ class RenderFlex extends RenderBox with ContainerRenderObjectMixin<RenderBox, Fl
            ...addendum,
            ErrorDescription(
              "If none of the above helps enough to fix this problem, please don't hesitate to file a bug:\n"
-              '  https://github.com/flutter/flutter/issues/new?template=2_bug.md',
+              '  https://github.com/flutter/flutter/issues/new?template=2_bug.yml',
            ),
          ]);
          return true;
--- a/packages/flutter/lib/src/widgets/framework.dart
+++ b/packages/flutter/lib/src/widgets/framework.dart
@ -2576,7 +2576,7 @@ class BuildOwner {
          ErrorHint(
            'If you did not attempt to call scheduleBuildFor() yourself, then this probably '
            'indicates a bug in the widgets framework. Please report it:\n'
-            '  https://github.com/flutter/flutter/issues/new?template=2_bug.md',
+            '  https://github.com/flutter/flutter/issues/new?template=2_bug.yml',
          ),
        ]);
      }
--- a/packages/flutter/test/foundation/assertions_test.dart
+++ b/packages/flutter/test/foundation/assertions_test.dart
@ -242,7 +242,7 @@ void main() {
        'This error should still help you solve your problem, however\n'
        'please also report this malformed error in the framework by\n'
        'filing a bug on GitHub:\n'
-        '  https://github.com/flutter/flutter/issues/new?template=2_bug.md\n'
+        '  https://github.com/flutter/flutter/issues/new?template=2_bug.yml\n'
        '═════════════════════════════════════════════════════════════════\n',
      );
    }
@ -279,7 +279,7 @@ void main() {
        'This error should still help you solve your problem, however\n'
        'please also report this malformed error in the framework by\n'
        'filing a bug on GitHub:\n'
-        '  https://github.com/flutter/flutter/issues/new?template=2_bug.md\n'
+        '  https://github.com/flutter/flutter/issues/new?template=2_bug.yml\n'
        '═════════════════════════════════════════════════════════════════\n',
      );
    }
@ -308,7 +308,7 @@ void main() {
        'This error should still help you solve your problem, however\n'
        'please also report this malformed error in the framework by\n'
        'filing a bug on GitHub:\n'
-        '  https://github.com/flutter/flutter/issues/new?template=2_bug.md\n'
+        '  https://github.com/flutter/flutter/issues/new?template=2_bug.yml\n'
        '═════════════════════════════════════════════════════════════════\n',
      );
    }
@ -408,7 +408,7 @@ void main() {
      'provide substantially more information in this error message to help you determine '
      'and fix the underlying cause.\n'
      'In either case, please report this assertion by filing a bug on GitHub:\n'
-      '  https://github.com/flutter/flutter/issues/new?template=2_bug.md',
+      '  https://github.com/flutter/flutter/issues/new?template=2_bug.yml',
    );
    expect(builder.properties[4] is ErrorSpacer, true);
    final DiagnosticsStackTrace trace = builder.properties[5] as DiagnosticsStackTrace;
--- a/packages/flutter_driver/lib/src/driver/web_driver.dart
+++ b/packages/flutter_driver/lib/src/driver/web_driver.dart
@ -311,7 +311,7 @@ class FlutterWebConnection {
        'If the test uses VM service extensions provided by the Flutter SDK, '
        'then this error is likely caused by a bug in Flutter. Please report it '
        'by filing a bug on GitHub:\n'
-        '  https://github.com/flutter/flutter/issues/new?template=2_bug.md',
+        '  https://github.com/flutter/flutter/issues/new?template=2_bug.yml',
        error,
        stackTrace,
      );
--- a/packages/flutter_localizations/lib/src/l10n/README.md
+++ b/packages/flutter_localizations/lib/src/l10n/README.md
@ -213,7 +213,7 @@ Google contributes translations for all the languages supported by
 this package. (Googlers, for more details see <go/flutter-l10n>.)

 If you have feedback about the translations please
-[file an issue on the Flutter github repo](https://github.com/flutter/flutter/issues/new?template=2_bug.md).
+[file an issue on the Flutter github repo](https://github.com/flutter/flutter/issues/new?template=2_bug.yml).


 ### See Also