Skip to content
This repository was archived by the owner on Nov 25, 2024. It is now read-only.

Commit de38be4

Browse files
authored
Expand issue template (#2103)
1 parent 96bf4aa commit de38be4

File tree

2 files changed

+32
-17
lines changed

2 files changed

+32
-17
lines changed

.github/ISSUE_TEMPLATE/BUG_REPORT.md

+31-15
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,50 @@ about: Create a report to help us improve
44

55
---
66

7-
<!-- All bug reports must provide the following background information -->
7+
<!--
8+
All bug reports must provide the following background information
9+
Text between <!-- and --​> marks will be invisible in the report.
10+
-->
811

912
### Background information
10-
13+
<!-- Please include versions of all software when known e.g database versions, docker versions, client versions -->
1114
- **Dendrite version or git SHA**:
1215
- **Monolith or Polylith?**:
1316
- **SQLite3 or Postgres?**:
1417
- **Running in Docker?**:
15-
- **`go version`**:
16-
17-
<!--
18+
- **`go version`**:
19+
- **Client used (if applicable)**:
1820

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

23-
You can also preview your report before submitting it. You may remove sections
24-
that aren't relevant to your particular case.
22+
### Description
2523

26-
Text between <!-- and --​> marks will be invisible in the report.
24+
- **What** is the problem:
25+
- **Who** is affected:
26+
- **How** is this bug manifesting:
27+
- **When** did this first appear:
2728

29+
<!--
30+
Examples of good descriptions:
31+
- What: "I cannot log in, getting HTTP 500 responses"
32+
- Who: "Clients on my server"
33+
- How: "Errors in the logs saying 500 internal server error"
34+
- When: "After upgrading to 0.3.0"
35+
36+
- What: "Dendrite ran out of memory"
37+
- Who: "Server admin"
38+
- How: "Lots of logs about device change updates"
39+
- When: "After my server joined Matrix HQ"
40+
41+
42+
Examples of bad descriptions:
43+
- What: "Can't send messages" - This is bad because it isn't specfic enough. Which endpoint isn't working and what is the response code? Does the message send but encryption fail?
44+
- Who: "Me" - Who are you? Running the server or a user on a Dendrite server?
45+
- How: "Can't send messages" - Same as "What".
46+
- When: "1 day ago" - It's impossible to know what changed 1 day ago without further input.
2847
-->
2948

30-
### Description
31-
32-
<!-- Describe here the problem that you are experiencing -->
33-
3449
### Steps to reproduce
50+
<!-- Please try reproducing this bug before submitting it. Issues which cannot be reproduced risk being closed. -->
3551

3652
- list the steps
3753
- that reproduce the bug

.github/PULL_REQUEST_TEMPLATE.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
### Pull Request Checklist
22

3-
<!-- Please read CONTRIBUTING.md before submitting your pull request -->
3+
<!-- Please read docs/CONTRIBUTING.md before submitting your pull request -->
44

5-
* [ ] I have added any new tests that need to pass to `sytest-whitelist` as specified in [docs/sytest.md](https://github.com/matrix-org/dendrite/blob/master/docs/sytest.md)
65
* [ ] Pull request includes a [sign off](https://github.com/matrix-org/dendrite/blob/master/docs/CONTRIBUTING.md#sign-off)
76

87
Signed-off-by: `Your Name <[email protected]>`

0 commit comments

Comments
 (0)