We develop several public and private plugins for QGIS users and our clients. During the testing phase, they often come across some bugs. To enable them to report the issues and include the right type of information, we have developed The Report plugin to simplify the process Report plugin.
The Report plugin helps developers get better bug reports from users, by auto-populating the relevant information. It also simplifies the bug reporting process for users.
The Report plugin can automatically extract information from the plugin crash as well as other important information for developers. With just one click you can report the issue to the official plugin issue tracker. No need of searching for a plugin’s tracker on the internet or copy-pasting long tracebacks to your browser.
- Install Report plugin from QGIS plugin offical repository
- Create a GitHub account if you do not have any existing
- Create a public access token GitHub with public_repo scope
- Click on the Report plugin toolbar button, Configure link and copy generated GitHub access token to the configuration dialog.
- Wait for next error and report the problem to the developers
<iframe width="420" height="315" src="https://www.youtube.com/embed/40aiJ793mjs"; frameborder="0" allowfullscreen></iframe>
- Feel free to download DevNull plugin from QGIS plugin offical repository to be able to test Report plugin
- After installation fo DevNull plugin, click on the new button /dev/null in your toolbar and watch how report plugin catches the exception
- Report any number of testing issues to DevNull Issue tracker, they are going to be deleted anyway!
- Report plugin works only with GitHub issue trackers
- Plugins must have “tracker” metadata filled in, so the Report plugin can detect the plugin issue tracker correctly
When/if QGIS issue tracker moves to GitHub, a similar tool can be added to the core to automatically report bugs and crashes.
Peter Petrik, Saber Razmjooei