Add instructions for writing useful bug reports #172
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
|  | ||
|
|
||
| ## 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. | ||
|
Contributor
There was a problem hiding this comment. Add "If your problem is with the 'flutter' tool, then:" or some such (since people attaching verbose "flutter run" output to every framework bug is going to get old fast) |
||
| * Attach the results of the command to the Github issue. | ||
|  | ||
|
|
||
| ## 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. | ||
|  | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Add:
|
||
| ## 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. | ||
|  | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a second paragraph here praising anyone who's willing to send us feedback.