Where and how to file bug reports
Posted: Thu Mar 31, 2022 6:50 pm
The Commander X16 software is being developed via GitHub.
If you encounter a problem with the emulator or the system ROM, start by posting a topic here. If other users can't help fix your problem, the next step is to file a bug report.
Bug reports should be filed in the correct location for the bug. Issues with the system software (ie: a BASIC command doesn't work as expected) should be filed to the ROM repository. Issues with the emulator (crashes or incorrect or inaccurate behavior) should be filed to the emulator repository. Likewise, documentation errors or incomplete documentation goes in the docs repo.
Emulator: https://github.com/commanderx16/x16-emulator/issues
ROM/Operating System: https://github.com/commanderx16/x16-rom/issues
Documentation: https://github.com/commanderx16/x16-docs/issues
The best way to resolve a documentation error is to fork the repository, edit the file yourself, and then create a Pull Request with the fixed text.
Video issues: https://github.com/fvdhoef/vera-module
Only for issues detected on actual hardware. Do not file a VERA issue for problems found in the emulator.
Follow the SID method when filing a bug report:
Search for an existing issue that covers the same problem. Do not file a new bug report if there's already one out there that covers the issue. You don't need to "me too" it, unless you have new information that will help identify or fix the bug.
Include detailed reproduction steps. Include enough detail that other people can reproduce and test the problem. If your bug requires specific data or program code, be prepared to attach that to the bug report.
Discuss it first in the support forum. Many bugs turn out to be mistakes in our own program or our own understanding of the KERNAL or the hardware.