diff options
| author | kegsay <kegan@matrix.org> | 2022-01-21 16:24:31 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-21 16:24:31 +0000 |
| commit | de38be469a23813921d01bef3e14e95faab2a59e (patch) | |
| tree | 78290937bce6cd7e475b5e5407a90d4a8fd927d3 | |
| parent | 96bf4aa8383e13624b823806b07a5878c8b3ade3 (diff) | |
Expand issue template (#2103)
| -rw-r--r-- | .github/ISSUE_TEMPLATE/BUG_REPORT.md | 46 | ||||
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 3 |
2 files changed, 32 insertions, 17 deletions
diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md index 68ae922a..206713e0 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.md +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -4,34 +4,50 @@ about: Create a report to help us improve --- -<!-- All bug reports must provide the following background information --> +<!-- +All bug reports must provide the following background information +Text between <!-- and --> marks will be invisible in the report. +--> ### Background information - +<!-- Please include versions of all software when known e.g database versions, docker versions, client versions --> - **Dendrite version or git SHA**: - **Monolith or Polylith?**: - **SQLite3 or Postgres?**: - **Running in Docker?**: -- **`go version`**: - -<!-- +- **`go version`**: +- **Client used (if applicable)**: -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. +### Description -Text between <!-- and --> marks will be invisible in the report. + - **What** is the problem: + - **Who** is affected: + - **How** is this bug manifesting: + - **When** did this first appear: +<!-- +Examples of good descriptions: +- What: "I cannot log in, getting HTTP 500 responses" +- Who: "Clients on my server" +- How: "Errors in the logs saying 500 internal server error" +- When: "After upgrading to 0.3.0" + +- What: "Dendrite ran out of memory" +- Who: "Server admin" +- How: "Lots of logs about device change updates" +- When: "After my server joined Matrix HQ" + + +Examples of bad descriptions: +- 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? +- Who: "Me" - Who are you? Running the server or a user on a Dendrite server? +- How: "Can't send messages" - Same as "What". +- When: "1 day ago" - It's impossible to know what changed 1 day ago without further input. --> -### Description - -<!-- Describe here the problem that you are experiencing --> - ### Steps to reproduce +<!-- Please try reproducing this bug before submitting it. Issues which cannot be reproduced risk being closed. --> - list the steps - that reproduce the bug diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 92253214..1204582e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,8 +1,7 @@ ### Pull Request Checklist -<!-- Please read CONTRIBUTING.md before submitting your pull request --> +<!-- Please read docs/CONTRIBUTING.md before submitting your pull request --> -* [ ] 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) * [ ] Pull request includes a [sign off](https://github.com/matrix-org/dendrite/blob/master/docs/CONTRIBUTING.md#sign-off) Signed-off-by: `Your Name <your@email.example.org>` |