Version 12 (modified by danvisel, 16 years ago) (diff) |
---|
Analysis
Overview
this should be invokable from help menu, or on internal error
The Bug report form eases communication between users and developers. The form contains:
- A log containing information useful for debugging. This field is read only.
- A custom text field containing user explanation on what happened. This is not a required field.
- A warning that user information such as working path and filenames will be sent.
Behavior:
- The bug report form appears automatically when an expected error occurs (exceptions, etc).
- The bug report form may be forced by the user using "Help->Send an error report"
Task requirements
- Define where and how the reports will be sent
- Create an extension for the "Send an error report" item for the Help menu.
- Implement invoking the Application bug report form automatically on catching an exceptions.
- Create the bug report form
- A dialog
- Titlebar
- Text fields
- Report and cancel buttons
- Depending on edition, the report should contain corresponding log file.
- Titlebar must contain Bug number or exception description.
Task result
Code.
Implementation idea
This is a draft diagram. For now, the checkbox is obsolete as it is hard to implement and not much useful.
Related
PLATFORM_STANDARDS_MANUAL_TESTS
How to demo
- Open Sophie 2.
- Perform an action that throws an error.
- Send an error report.
- Show where the error reports are stored.
Design
Implementation
(Implementation results should be described and linked here (from the wiki or the repository))
Testing
Comments
danvisel: A note on this: I think it's important to get the user's email address in some way. In Sophie 1, 95% of the time, users just clicked "okay", we were sent a bug report, and then couldn't do very much with it because we didn't know anything about the book, what was being done, and we didn't have any way to contact the user about it. I think in the pre-release versions of Sophie 2 we should get the user's email address the first time they start the program; this should be sent with the bug report so we have some way to get more useful information for debugging.