Report an issue
How to report a bug or ask for a feature on GitHub so that it can be reproduced. Use it when Troubleshooting and the FAQ did not solve your problem. It lists what to check first, what to include, and what to keep private.
Before you report
Bugs and feature requests go to the GitHub issue tracker. You need a free GitHub account. Check these two pages first, because they answer the common cases and can save you the wait:
| Page | Check it when |
|---|---|
| Troubleshooting | An icon is missing, wrong, or does not update, or an SVG shows warnings. |
| FAQ | You are not sure whether the app can do something, or what it changes on your Mac. |
What to include
A report that names the versions and the steps can be reproduced. Add one item for each row below that applies to your problem.
| Include | Where to find it |
|---|---|
| The app version. | In the footer of the manager window, in the menu bar menu, or in Version under About in the Settings window. It looks like 1.2.0 (47). |
| The macOS version. | Apple menu then About This Mac |
| What you did. | Your own notes. List the steps in order, starting from the manager window. |
| What you expected. | Your own notes. One sentence is enough. |
| What happened instead. | Your own notes, plus a screenshot of the sidebar or the window if it helps. |
| Whether the favorite uses Both icons mode. | In the favorite editor, under the icon mode choice. See Keeping both icons. |
| The state of the favorite’s helper. | Under Finder Sync Helpers in the Settings window, as the line shown beside the favorite’s SBF- name. |
| The warnings for an SVG. | In the import sheet and the editor. Copy the text as shown. Attach the SVG too if you can share it. |
| A configuration issue. | A Configuration Issue notice in Settings. Say that it appeared. The unreadable file is kept as config. next to the original. See If the file cannot be read. |
How to file it
Open the issue tracker and sign in to GitHub.
You seeThe list of open issues for SidebarFavorites.
Search the list for your problem.
One issue with several reports is easier to fix than several copies of the same one.
You seeEither an issue that matches yours, or no result. If one matches, add your details to it instead of opening another.
Click New issue.
You seeGitHub shows the form for a new issue.
Write a short title that names the problem, then fill in the details from the table above.
Click Submit new issue.
You seeThe issue is published with its own number, and GitHub emails you when someone replies.
What not to attach
GitHub issues are public. Look at anything you attach before you submit it.