Report A Bug
September 1, 2018
Bug reporting is an important part of building and improving on this project. Mirror Island aims to be a community driven project that listens as much as possible towards its users.
First of all, bugs can come in many forms. Even if there isn't an actual software bug found but rather a user wasn't sure how to do something, that is important for us to know.
Secondly, bug reports don't have to be formal as long as they are informative. The quicker we can read bug reports the quicker we can fix any errors.
Since development on this website and related projects is done in a collaborative way, here are a few tips that can speed things up:
- Do not include any personally identifying information that is not public information. A personal page such as a blog or gallery that can be accessed without needing any special priveleges is fine, however as it is publicly available anyway.
- Be specific. Instead of listing multiple bugs in one report, write short but specific reports for each one. (For example, images disappearing during editing, and not being able to save are two different problems.)
- Avoid including links to copies of error messages, screenshots, or file attachments on other hosting services. Instead, include all of this information in an email since the developers will have all information needed in a single message without having to navigate to other locations on the internet for more information.
- If the problem is with the website, try to repeat the bug before and after a browser refresh. If you notice a difference include it with the report.
- Some bugs may take longer or need a higher priority than others to be fixed, meaning a recently reported bug may take a while to fix.
When reporting a bug, break it up in 4 parts:
- Describe what browser software and operating system you are using, and (if possible) the software version would be very helpful. It doesn't have to be specific and a description such as "I'm using Firefox on Android" would be sufficient.
- Describe what you thought was incorrect, and what should of happened.
- Describe the steps needed to repeat the bug. If you can't repeat the bug, at least describe what you did to the best of your recollection. Also describe how often it happens whether it always happens or only occasionally.
- A complete and identical copy of any error messages that may of been displayed. Take screenshots, if possible.
Once you have written out your bug report, you can send a copy of it by email to the address located on our Contact Us page.
Displayed below is an example bug report describing a fictitious error that occurs when a popup menu is displayed.
Sample Bug Report
I'm using Chromium on Debian, Windows 10, and macOS. When I click on the menu icon the menu itself appears near the bottom of the screen instead of under the menu icon. This is what happened: Start a new post and add anything to it. Photos, files, whatever. Save the post. Before refreshing the page, hover the mouse on the edit icon. The menu will popup near the bottom of the screen and it disappears before I can click on it. This always happens no matter what OS I'm using, but only if I don't reload the page. Otherwise it goes away when the page loads again. I can be contacted at firstname.lastname@example.org Regards, Felix