diff --git a/bug_reports.md b/bug_reports.md new file mode 100644 index 00000000000..2cbea4ca0cf --- /dev/null +++ b/bug_reports.md @@ -0,0 +1,32 @@ +--- +layout: page +title: Creating Useful Bug Reports +permalink: /bug_reports/ +--- + +The instructions in this document detail the current steps required to provide the most actionable bug reports for crashes and other bad behavior. Each step is optional but will greatly improve how quickly issues are diagnosed and addressed. We appreciate your effort in sending us as much feedback as possible. + +## Create an Issue on Github +* A new Github issue may be created at https://github.com/flutter/flutter/issues/new + +## Provide the Flutter Version +* Run `flutter --version` in your project and paste the results into the Github Issue +![flutter version](/images/flutter_version.png) + +## Run the Command in Verbose Mode +Follow these steps only if your issue is related to the `flutter` tool. +* All Flutter commands accept the `--verbose` flag. If attached to the issue, the output from this command may aid in diagnosing the issue. +* Attach the results of the command to the Github issue. +![flutter verbose](/images/verbose_flag.png) + +## Provide the Most Recent Logs +* Logs for the currently connected device may be accessed via `flutter logs` +* If the crash is reproducible, clear the logs (⌘ + k on Mac), reproduce the crash and copy the newly generated logs into a file attached to the bug report. +* If you are getting exceptions thrown by the framework, include all the output between and including the dashed lines of the first such exception. +![flutter logs](/images/logs.png) + +## Provide the Crash Report +* In case the iOS simulator crashes, a crash report is generated in `~/Library/Logs/DiagnosticReports/`. +* In case the iOS device crashes, a crash report is generated in `~/Library/Logs/CrashReporter/MobileDevice`. +* Find the report corresponding to the crash (usually the latest) and attach it to the Github issue. +![crash report](/images/crash_reports.png) diff --git a/images/crash_reports.png b/images/crash_reports.png new file mode 100755 index 00000000000..7cbbc5084e9 Binary files /dev/null and b/images/crash_reports.png differ diff --git a/images/flutter_version.png b/images/flutter_version.png new file mode 100755 index 00000000000..7a9be9637c1 Binary files /dev/null and b/images/flutter_version.png differ diff --git a/images/logs.png b/images/logs.png new file mode 100755 index 00000000000..bf1cf647103 Binary files /dev/null and b/images/logs.png differ diff --git a/images/verbose_flag.png b/images/verbose_flag.png new file mode 100755 index 00000000000..b2cb159371d Binary files /dev/null and b/images/verbose_flag.png differ diff --git a/index.md b/index.md index 3bb03f62d6a..8413285a34f 100644 --- a/index.md +++ b/index.md @@ -39,4 +39,5 @@ to install Flutter and run your first app on Android and iOS. - [Source on GitHub](https://github.com/flutter/flutter) - [Issue tracker](https://github.com/flutter/flutter/issues) + - [Writing Useful Bug Reports](bug_reports) - [FAQ](faq)