diff options
| author | Neil Alexander <neilalexander@users.noreply.github.com> | 2022-10-10 11:03:52 +0100 |
|---|---|---|
| committer | Neil Alexander <neilalexander@users.noreply.github.com> | 2022-10-10 11:03:52 +0100 |
| commit | b32b6d6e8eb5d0a6c22e9215e2fccf4bdd1db8c3 (patch) | |
| tree | 493f87a1f563375d3ffac653179fb79fc8024948 /.github | |
| parent | 04bab142901b9dc4479b2cf4e5504fbdd9dd3cf1 (diff) | |
Update issue and pull request templates
Diffstat (limited to '.github')
| -rw-r--r-- | .github/ISSUE_TEMPLATE/BUG_REPORT.md | 22 | ||||
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 4 |
2 files changed, 14 insertions, 12 deletions
diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md index 206713e0..49c9a37e 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.md +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -7,24 +7,27 @@ about: Create a report to help us improve <!-- All bug reports must provide the following background information Text between <!-- and --> marks will be invisible in the report. + +IF YOUR ISSUE IS CONSIDERED A SECURITY VULNERABILITY THEN PLEASE STOP AND +DO NOT POST IT AS A GITHUB ISSUE! Please report the issue responsibly by +disclosing in private by email to security@matrix.org instead. --> ### 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?**: +- **Dendrite version or git SHA**: +- **Monolith or Polylith?**: +- **SQLite3 or Postgres?**: +- **Running in Docker?**: - **`go version`**: - **Client used (if applicable)**: - ### Description - - **What** is the problem: - - **Who** is affected: - - **How** is this bug manifesting: - - **When** did this first appear: +- **What** is the problem: +- **Who** is affected: +- **How** is this bug manifesting: +- **When** did this first appear: <!-- Examples of good descriptions: @@ -38,7 +41,6 @@ Examples of good descriptions: - 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? diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e0b82e2a..d6c54ead 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,8 +1,8 @@ ### Pull Request Checklist -<!-- Please read docs/CONTRIBUTING.md before submitting your pull request --> +<!-- Please read https://matrix-org.github.io/dendrite/development/contributing before submitting your pull request --> * [ ] I have added tests for PR _or_ I have justified why this PR doesn't need tests. -* [ ] Pull request includes a [sign off](https://github.com/matrix-org/dendrite/blob/main/docs/CONTRIBUTING.md#sign-off) +* [ ] Pull request includes a [sign off below using a legally identifiable name](https://matrix-org.github.io/dendrite/development/contributing#sign-off) _or_ I have already signed off privately Signed-off-by: `Your Name <your@email.example.org>` |