2018-05-17 05:51:14 +08:00
|
|
|
|
Setup your environment
|
|
|
|
|
|
----------------------
|
|
|
|
|
|
|
|
|
|
|
|
- Be ready for data loss. Backup your account and link your account to
|
|
|
|
|
|
as many devices as possible.
|
|
|
|
|
|
- Install the latest version (or even a beta version) of Ring. It is
|
|
|
|
|
|
useless to report bugs on older versions.
|
|
|
|
|
|
|
|
|
|
|
|
How to report a bug
|
|
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
|
|
|
|
1\. Figure out the steps to reproduce the bug:
|
|
|
|
|
|
|
|
|
|
|
|
- If you have precise steps to reproduce it — great! — you're on your
|
|
|
|
|
|
way to creating a useful bug report.
|
|
|
|
|
|
- If you can reproduce occasionally, but not after following specific
|
|
|
|
|
|
steps, you must provide additional information for the bug report to
|
|
|
|
|
|
be useful.
|
|
|
|
|
|
- If you can't reproduce the problem, there's probably no use in
|
|
|
|
|
|
reporting it, unless you provide unique information about
|
|
|
|
|
|
its occurrence.
|
|
|
|
|
|
- If the bug leads to other bugs afterward that you can't reproduce
|
|
|
|
|
|
some other way, there's probably no use in reporting it.
|
|
|
|
|
|
|
|
|
|
|
|
2\. Make sure your software is up to date. Ideally, test an
|
|
|
|
|
|
in-development version to see whether your bug has already been fixed
|
|
|
|
|
|
|
|
|
|
|
|
3\. Try to isolate from environment and reproduce (ie: test on multiple
|
|
|
|
|
|
devices)
|
|
|
|
|
|
|
|
|
|
|
|
4\. Describe your environment(s) by specifying the following:
|
|
|
|
|
|
|
|
|
|
|
|
- precise device model
|
|
|
|
|
|
- android version
|
|
|
|
|
|
- if you are using a beta version
|
|
|
|
|
|
- if you are using the F-Droid build
|
|
|
|
|
|
|
|
|
|
|
|
5\. If you have multiple issues, please file separate bug reports. It
|
|
|
|
|
|
will be much easier to track bugs that way.
|
|
|
|
|
|
|
|
|
|
|
|
Writing a clear summary
|
|
|
|
|
|
-----------------------
|
|
|
|
|
|
|
|
|
|
|
|
How would you describe the bug using approximately 10 words? This is the
|
|
|
|
|
|
first part of your bug report a developer will see.
|
|
|
|
|
|
|
|
|
|
|
|
A good summary should quickly and uniquely identify a bug report. It
|
|
|
|
|
|
should explain the problem, not your suggested solution.
|
|
|
|
|
|
|
2018-05-17 05:53:13 +08:00
|
|
|
|
```
|
|
|
|
|
|
Good: "Cancelling a file transfer crashes Ring"
|
|
|
|
|
|
Bad: "Software crashes"
|
|
|
|
|
|
```
|
2018-05-17 05:51:14 +08:00
|
|
|
|
|
2018-05-17 05:53:13 +08:00
|
|
|
|
```
|
|
|
|
|
|
Good: "All calls hang up after 32 seconds"
|
|
|
|
|
|
Bad: "Not able to call my friends"
|
|
|
|
|
|
```
|
2018-05-17 05:51:14 +08:00
|
|
|
|
|
|
|
|
|
|
Writing precise steps to reproduce
|
|
|
|
|
|
----------------------------------
|
|
|
|
|
|
|
|
|
|
|
|
- How can a developer reproduce the bug on his or her own device?
|
|
|
|
|
|
|
|
|
|
|
|
Steps to reproduce are the most important part of any bug report. If a
|
|
|
|
|
|
developer is able to reproduce the bug, the bug is very likely to be
|
|
|
|
|
|
fixed. If the steps are unclear, it might not even be possible to know
|
|
|
|
|
|
whether the bug has been fixed. We are totally aware that some bugs may
|
|
|
|
|
|
look obvious to you, but they are probably related to your environment.
|
|
|
|
|
|
The more precise you are, the quicker the bug is fixed.
|
|
|
|
|
|
|
|
|
|
|
|
- What should you include in a bug report?
|
|
|
|
|
|
|
|
|
|
|
|
Indicate whether you can reproduce the bug at will, occasionally, or not
|
|
|
|
|
|
at all. Describe your method of interacting with Ring in addition to the
|
|
|
|
|
|
intent of each step. After your steps, precisely describe the observed
|
|
|
|
|
|
(actual) result and the expected result. Clearly separate facts
|
|
|
|
|
|
(observations) from speculations.
|
|
|
|
|
|
|
|
|
|
|
|
Good : I can always reproduce by following these steps:
|
|
|
|
|
|
|
2018-05-17 05:53:13 +08:00
|
|
|
|
```
|
|
|
|
|
|
1. Start Ring by clicking on the desktop icon
|
|
|
|
|
|
2. Start a new conversation with anyone
|
|
|
|
|
|
3. Click file transfer icon
|
2018-05-17 05:51:14 +08:00
|
|
|
|
|
2018-05-17 05:53:13 +08:00
|
|
|
|
Expected results: A window opens and ask me to choose a file to send.
|
|
|
|
|
|
Actual results: When I click the file transfer icon, nothing happens.
|
|
|
|
|
|
```
|
2018-05-17 05:51:14 +08:00
|
|
|
|
|
|
|
|
|
|
Bad :
|
|
|
|
|
|
|
2018-05-17 05:53:13 +08:00
|
|
|
|
```
|
|
|
|
|
|
Try to transfer a file
|
|
|
|
|
|
It doesn't work.
|
|
|
|
|
|
```
|
2018-05-17 05:51:14 +08:00
|
|
|
|
|
|
|
|
|
|
Providing additional information
|
|
|
|
|
|
--------------------------------
|
|
|
|
|
|
|
|
|
|
|
|
The following information is requested for most bug reports. You can
|
|
|
|
|
|
save time by providing this information below the Expected results.
|
