This repository was archived by the owner on Apr 26, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Use a GitHub form for issues rather than a hard-to-read, easy-to-ignore template. #12982
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
8a8b6e4
Add a bug report form
reivilibre 788672d
Remove the bug report 'template' that is hard to read and easy to ignore
reivilibre 244bc39
Newsfile
reivilibre 77eedb6
Apply suggestions from code review
reivilibre fab51a8
Add more requirements
reivilibre 3b98d97
Remove midsentence line breaks
reivilibre 284d9b7
Update .github/ISSUE_TEMPLATE/BUG_REPORT.yml
reivilibre be6b68b
Add horizontal rule
reivilibre File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| name: Bug report | ||
| description: Create a report to help us improve | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| **THIS IS NOT A SUPPORT CHANNEL!** | ||
| **IF YOU HAVE SUPPORT QUESTIONS ABOUT RUNNING OR CONFIGURING YOUR OWN HOME SERVER**, please ask in **[#synapse:matrix.org](https://matrix.to/#/#synapse:matrix.org)** (using a matrix.org account if necessary). | ||
|
|
||
| If you want to report a security issue, please see https://matrix.org/security-disclosure-policy/ | ||
|
|
||
| This is a bug report form. By following the instructions below and completing 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. | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Description | ||
| description: Describe the problem that you are experiencing | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: reproduction_steps | ||
| attributes: | ||
| label: Steps to reproduce | ||
| description: | | ||
| Describe the series of steps that leads you to the problem. | ||
|
|
||
| Describe how what happens differs from what you expected. | ||
| placeholder: Tell us what you see! | ||
| value: | | ||
| - list the steps | ||
| - that reproduce the bug | ||
| - using hyphens as bullet points | ||
| validations: | ||
| required: true | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| --- | ||
|
|
||
| **IMPORTANT**: please answer the following questions, to help us narrow down the problem. | ||
| - type: input | ||
| id: homeserver | ||
| attributes: | ||
| label: Homeserver | ||
| description: Which homeserver was this issue identified on? (matrix.org, another homeserver, etc) | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: version | ||
| attributes: | ||
| label: Synapse Version | ||
| description: | | ||
| What version of Synapse is this homeserver running? | ||
|
|
||
| You can find the Synapse version by visiting https://yourserver.example.com/_matrix/federation/v1/version | ||
|
|
||
| or with this command: | ||
|
|
||
| ``` | ||
| $ curl http://localhost:8008/_synapse/admin/v1/server_version | ||
| ``` | ||
|
|
||
| (You may need to replace `localhost:8008` if Synapse is not configured to listen on that port.) | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: install_method | ||
| attributes: | ||
| label: Installation Method | ||
| options: | ||
| - Docker (matrixdotorg/synapse) | ||
| - Debian packages from packages.matrix.org | ||
| - pip (from PyPI) | ||
| - Other (please mention below) | ||
| - type: textarea | ||
| id: platform | ||
| attributes: | ||
| label: Platform | ||
| description: | | ||
| Tell us about the environment in which your homeserver is operating... | ||
| e.g. distro, hardware, if it's running in a vm/container, etc. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: logs | ||
reivilibre marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| attributes: | ||
| label: Relevant log output | ||
| description: | | ||
| Please copy and paste any relevant log output, ideally at INFO or DEBUG log level. | ||
| This will be automatically formatted into code, so there is no need for backticks. | ||
|
|
||
| Please be careful to remove any personal or private data. | ||
|
|
||
| **Bug reports are usually very difficult to diagnose without logging.** | ||
| render: shell | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: anything_else | ||
| attributes: | ||
| label: Anything else that would be useful to know? | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Use a GitHub form for issues rather than a hard-to-read, easy-to-ignore template. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.