Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Issue template for Synapse #2413

Merged
merged 5 commits into from
Aug 21, 2017
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<!--

**IF YOU HAVE SUPPORT QUESTIONS ABOUT RUNNING OR CONFIGURING YOUR OWN HOME SERVER**:
You will likely get better support more quickly if you ask in ** #matrix:matrix.org ** ;)


This is a bug report template. By following the instructions below and
filling out the sections with your information, you will help the us to get all
the necessary data to fix your issue.

You can also preview your report before submitting it. You may remove sections
that aren't relevant to your particular case.

Text between <!-- and --​> marks will be invisible in the report.

-->

### Description

Describe here the problem that you are experiencing, or the feature you are requesting.

### Steps to reproduce

- For bugs, list the steps
- that reproduce the bug
- using hyphens as bullet points

Describe how what happens differs from what you expected.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 :)


### Version information

<!-- IMPORTANT: please answer the following questions, to help us narrow down the problem -->

- **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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add the version of the running instance (if known).
And maybe the install method (via package manager/ via git clone/ ...)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed; thanks.