Reporting a Bug
Report problems with the app so they can be reproduced and fixed.
If something does not work as expected, you can help us fix it by opening an issue on GitHub. A good report lets us reproduce the problem quickly, so please take a moment to gather the details described below before you submit it.
Try to reproduce it first
Before opening an issue, try to reproduce the problem yourself. Note down the exact steps you took, what you expected to happen, and what happened instead. A bug that can be reproduced is much easier to fix than one that only appeared once.
Collect the logs
StretcherUI writes rolling log files that capture what the application and the underlying device API were doing when the problem occurred. Attaching them to your report gives us the context we need to track down the cause.
You can find the log files in the logs folder inside the application data directory:
- Windows:
%APPDATA%\Stretcher\logs - macOS:
~/.config/Stretcher/logs
The logs roll over once per day, so each day produces one set of files, such as stretcher-ui-<date>.log and
stretcher-api-<date>.log. Pick the set from the day the problem occurred and attach all files from that date,
not just a single one. If you are unsure, simply attach the most recent set.
Where to paste a path
On Windows you can paste %APPDATA%\Stretcher\logs directly into the address bar of the file explorer to jump
straight to the folder.
Open a GitHub issue
Once you have your reproduction steps and the relevant log files, open an issue (TODO: update link) on GitHub. Please include:
- A short, descriptive title.
- The steps to reproduce the problem.
- What you expected to happen and what happened instead.
- The log files from when the problem occurred.
The more of this you can provide, the faster we can reproduce and fix the issue.