Issue template for Synapse #2413
Conversation
A new issue template proposed to try and steer people towards #matrix:matrix.org for support queries relating to running their own homeserver.
Oops capital L.
Removed the sentence encouraging people not to file a bug - if people are in doubt we'd rather they filed a bug than gave up entirely.
| - that reproduce the bug | ||
| - using hyphens as bullet points | ||
|
|
||
| Describe how what happens differs from what you expected. |
There was a problem hiding this comment.
Suggestion: Include some text to ask for log snippets. It's hard to troubleshoot issues without stacktraces or any indication as to what is going on. Similar to the "please screenshot it" in Riot.
There was a problem hiding this comment.
Yeah, I stopped short of asking for logs since we've got no secure way to receive them (other than via Riot itself), but we could ask for 'relevant log snippets' if the user is able to provide them.
Ideally we'd also expose the rageshake server to receive logs securely, but that will need time to develop :)
ISSUE_TEMPLATE.md
Outdated
|
|
||
| - **Homeserver**: was this issue identified on matrix.org or another homeserver? | ||
| - **Platform**: tell us about the environment in which your homeserver is operating | ||
| - distro, hardware, if it's running in a vm/container, etc. |
There was a problem hiding this comment.
I would add the version of the running instance (if known).
And maybe the install method (via package manager/ via git clone/ ...)
Responding to review comments.
Added instructions for checking server version.
|
honestly I think this errs to much towards an implication that we might actually bother to look at things reported here, but ymmv. |
|
Well, the whole idea is to reduce the signal/noise ratio, so perhaps we even will actually look at some of these things :P |
PR #2413 added an issue template, but just adding files to the project directory upsets the packaging scripts: we need to explicitly include or exclude them. Move the template into a .github directory to make that easy, and to de-clutter the root a bit.
PR #2413 added an issue template, but just adding files to the project directory upsets the packaging scripts: we need to explicitly include or exclude them. Move the template into a .github directory to make that easy, and to de-clutter the root a bit.
Encouraging users to try #matrix:matrix.org for support queries in preference to filing a bug.