ci: Simplify GH bug report template#3381
Conversation
Simplify the bug report form further by dropping / merging form sections. - Minor revisions and formatting changes. - Collapsed OS + Arch into single input field. - Description/reproduction and expectation sections revised. Expectation intent should be covered/inferred by the issue description, while detailed reproduction steps can be it's own optional section. - Removed platform dropdown (Windows and macOS are mentioned in description as unsupported). - Removed experience checkboxes (context doesn't really change responses).
- Remove the orchestrator dropdown (we don't seem to use this information, it's just noise) - Relocate the DMS version + OS/Arch sections to come after the Reproduction steps.
polarathene
added
area/ci
kind/improvement
| - the [documentation on debugging](https://docker-mailserver.github.io/docker-mailserver/latest/config/debugging/), tried the proposed steps to debug the problem, but was still unable to resolve the issue; | ||
| - this project's [Code of Conduct](https://github.com/docker-mailserver/docker-mailserver/blob/master/CODE_OF_CONDUCT.md) and I agree; | ||
| - the [documentation about filing a bug report](https://docker-mailserver.github.io/docker-mailserver/latest/contributing/issues-and-pull-requests/#filing-a-bug-report). | ||
| I have read: |
There was a problem hiding this comment.
I intentionally added two spaces at the end of this line, thinking it might help with the initial formatting.
When filing the issue, it's not properly markdown formatted into multi-line list, only after submission. Seems to be due to a restriction on label perhaps? Whereas if it was in description it'd be rendered as a list.
There was a problem hiding this comment.
I intentionally added two spaces at the end of this line, thinking it might help with the initial formatting.
I noticed this behavior as well. Does your fix with the spaces improve the situation? The preview is still a bit gobbled I think..
There was a problem hiding this comment.
Does your fix with the spaces improve the situation?
🤷♂️ I haven't tried it out on a test repo sorry 😅
A future revision can move this into description, with the first two checkbox items being added to debug docs.
There was a problem hiding this comment.
Merged, it did not help 😢
Form looks better overall though I think 😎
2 participants
Description
Simplify the bug report form further by dropping / merging form sections. Partially inspired
uptime-kumareport.Presently the bug report form seems to have plenty of redundant content that maintainers don't leverage as context for responding or triaging any differently. They were originally intended to save us time but I don't recall that happening, sometimes information by the reporter was still communicated at a later stage.
In my experience, it's just additional noise for us and minor friction to the reporter. When the debug docs page is improved, we can probably simplify the "Preliminary Checks" section too (or migrate common gotchas to still be visible on the bug report page as markdown comment placeholder in the "What Happened?" section).
Changes by Commits: