Add a pull request template and add multiple issue templates

Signed-off-by: Aaron Raimist <aaron@raim.ist>
This commit is contained in:
Aaron Raimist 2018-11-13 21:43:23 -06:00
parent 81d4f51524
commit d86826277d
No known key found for this signature in database
GPG Key ID: 37419210002890EF
4 changed files with 53 additions and 10 deletions

View File

@ -1,3 +1,9 @@
---
name: Bug report
about: Create a report to help us improve
---
<!-- <!--
**IF YOU HAVE SUPPORT QUESTIONS ABOUT RUNNING OR CONFIGURING YOUR OWN HOME SERVER**: **IF YOU HAVE SUPPORT QUESTIONS ABOUT RUNNING OR CONFIGURING YOUR OWN HOME SERVER**:
@ -11,38 +17,50 @@ the necessary data to fix your issue.
You can also preview your report before submitting it. You may remove sections You can also preview your report before submitting it. You may remove sections
that aren't relevant to your particular case. that aren't relevant to your particular case.
Text between <!-- and --> marks will be invisible in the report. Text between <!-- and --> marks will be invisible in the report.
--> -->
### Description ### Description
Describe here the problem that you are experiencing, or the feature you are requesting. <!-- Describe here the problem that you are experiencing -->
### Steps to reproduce ### Steps to reproduce
- For bugs, list the steps - list the steps
- that reproduce the bug - that reproduce the bug
- using hyphens as bullet points - using hyphens as bullet points
<!--
Describe how what happens differs from what you expected. Describe how what happens differs from what you expected.
<!-- If you can identify any relevant log snippets from _homeserver.log_, please include If you can identify any relevant log snippets from _homeserver.log_, please include
those (please be careful to remove any personal or private data). Please surround them with those (please be careful to remove any personal or private data). Please surround them with
``` (three backticks, on a line on their own), so that they are formatted legibly. --> ``` (three backticks, on a line on their own), so that they are formatted legibly.
-->
### Version information ### Version information
<!-- IMPORTANT: please answer the following questions, to help us narrow down the problem --> <!-- IMPORTANT: please answer the following questions, to help us narrow down the problem -->
- **Homeserver**: Was this issue identified on matrix.org or another homeserver? <!-- Was this issue identified on matrix.org or another homeserver? -->
- **Homeserver**:
If not matrix.org: If not matrix.org:
- **Version**: What version of Synapse is running? <!--
<!--
What version of Synapse is running?
You can find the Synapse version by inspecting the server headers (replace matrix.org with You can find the Synapse version by inspecting the server headers (replace matrix.org with
your own homeserver domain): your own homeserver domain):
$ curl -v https://matrix.org/_matrix/client/versions 2>&1 | grep "Server:" $ curl -v https://matrix.org/_matrix/client/versions 2>&1 | grep "Server:"
--> -->
- **Install method**: package manager/git clone/pip - **Version**:
- **Platform**: Tell us about the environment in which your homeserver is operating
- distro, hardware, if it's running in a vm/container, etc. - **Install method**:
<!-- examples: package manager/git clone/pip -->
- **Platform**:
<!--
Tell us about the environment in which your homeserver is operating
distro, hardware, if it's running in a vm/container, etc.
-->

View File

@ -0,0 +1,9 @@
---
name: Feature request
about: Suggest an idea for this project
---
**Description:**
<!-- Describe here the feature you are requesting. -->

View File

@ -0,0 +1,9 @@
---
name: Support Request
about: I need support for Synapse
---
# Please ask for support in [**#matrix:matrix.org**](https://matrix.to/#/#matrix:matrix.org)
## Don't file an issue as a support request.

7
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@ -0,0 +1,7 @@
### Pull Request Checklist
<!-- Please read CONTRIBUTING.rst before submitting your pull request -->
* [ ] Pull request is based on the develop branch
* [ ] Pull request includes a [changelog file](CONTRIBUTING.rst#changelog)
* [ ] Pull request includes a [sign off](CONTRIBUTING.rst#sign-off)