BugHunt
Posted: Fri Jun 09, 2017 4:26 pm
This is a proposal to overhaul bug reports/issue handling on the tgstation project*.
Currently, if a player ahelps with a bug report, we ask that they click Report Issue and open a new issue against the project on github. With the current system, I feel that the pros outweigh the cons:
PROS:
- It's github, I guess?
CONS:
- Asking people to register just to report an issue is detrimental
- The issue format isn't necessarily coherent
- There is no filtering or checking for previously reported issues
My solution* for this is several components working hand in hand:
1. A set of new in-game bug reporting procs that can automatically collect information like server revision, testmerged PRs, round IDs, individual logs etc
1.1 A new ahelp response link: (BUG) that marks the ahelp as a bug report and automatically sends the user into the "submit a report" flow
1.2 A whitelisted set of or specifically admin rank'd players get notified of this bug report
1.3 A management interface similar to the current ahelp ticket system (or integrated with it)
2. A database backend for new bug reports that we(meaning coders/maintainers) can monitor and moderate
2.1 Of course with a fancy/easy to use interface courtesy of yours truly
3. A tool to automatically submit selected bug reports as official issues on the tgstation repo
PROS:
- Players don't have to register elsewhere to report a bug, so we get more of them
- The issue list on the repo becomes more useful (removal of duplicate issues, known issues etc) thanks to in-game and web-based triage
- Immediate feedback for requests for more information, if any is needed
CONS:
- Additional work for coders/admins to moderate the bug queue
- Requires additional configuration between gameservers <-> github
- Screenshots aren't as easy to secure
* This might be a solution looking for a problem
Currently, if a player ahelps with a bug report, we ask that they click Report Issue and open a new issue against the project on github. With the current system, I feel that the pros outweigh the cons:
PROS:
- It's github, I guess?
CONS:
- Asking people to register just to report an issue is detrimental
- The issue format isn't necessarily coherent
- There is no filtering or checking for previously reported issues
My solution* for this is several components working hand in hand:
1. A set of new in-game bug reporting procs that can automatically collect information like server revision, testmerged PRs, round IDs, individual logs etc
1.1 A new ahelp response link: (BUG) that marks the ahelp as a bug report and automatically sends the user into the "submit a report" flow
1.2 A whitelisted set of or specifically admin rank'd players get notified of this bug report
1.3 A management interface similar to the current ahelp ticket system (or integrated with it)
2. A database backend for new bug reports that we(meaning coders/maintainers) can monitor and moderate
2.1 Of course with a fancy/easy to use interface courtesy of yours truly
3. A tool to automatically submit selected bug reports as official issues on the tgstation repo
PROS:
- Players don't have to register elsewhere to report a bug, so we get more of them
- The issue list on the repo becomes more useful (removal of duplicate issues, known issues etc) thanks to in-game and web-based triage
- Immediate feedback for requests for more information, if any is needed
CONS:
- Additional work for coders/admins to moderate the bug queue
- Requires additional configuration between gameservers <-> github
- Screenshots aren't as easy to secure
* This might be a solution looking for a problem