diff options
author | Kegsay <kegan@matrix.org> | 2020-10-01 15:00:16 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-10-01 15:00:16 +0100 |
commit | 378a0520be8a03ee4c0bab6de8a1fff24bf4dcdf (patch) | |
tree | a8f6f59738fd5635012b87d8e6bdc3f0c2050d78 /.github | |
parent | 43b3c4a2fc493fa6cacf0174f8c9f31f6b9c88c1 (diff) |
Add custom issue templates; fixes #1421 (#1460)
Diffstat (limited to '.github')
-rw-r--r-- | .github/ISSUE_TEMPLATE/BUG_REPORT.md | 49 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md | 14 | ||||
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 2 |
3 files changed, 64 insertions, 1 deletions
diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md new file mode 100644 index 00000000..68ae922a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -0,0 +1,49 @@ +--- +name: Bug report +about: Create a report to help us improve + +--- + +<!-- All bug reports must provide the following background information --> + +### Background information + +- **Dendrite version or git SHA**: +- **Monolith or Polylith?**: +- **SQLite3 or Postgres?**: +- **Running in Docker?**: +- **`go version`**: + +<!-- + +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. + +Text between <!-- and --> marks will be invisible in the report. + +--> + +### Description + +<!-- Describe here the problem that you are experiencing --> + +### Steps to reproduce + +- list the steps +- that reproduce the bug +- using hyphens as bullet points + +<!-- +Describe how what happens differs from what you expected. + +If you can identify any relevant log snippets from server logs, please include +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. + +Alternatively, please send logs to @kegan:matrix.org or @neilalexander:matrix.org +with a link to the respective Github issue, thanks! +--> diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md new file mode 100644 index 00000000..084f683b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md @@ -0,0 +1,14 @@ +--- +name: Feature request +about: Suggest an idea for this project + +--- + +<!-- +Please do not open feature requests for missing parts of the Matrix specification. +We are tracking those features under https://github.com/matrix-org/dendrite/issues?q=is%3Aissue+is%3Aopen+label%3Aare-we-synapse-yet +--> + +**Description:** + +<!-- Describe here the feature you are requesting. --> diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 8d22f7f7..c1cb8d7c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,5 +2,5 @@ <!-- Please read CONTRIBUTING.md before submitting your pull request --> -* [ ] I have added any new tests that need to pass to `testfile` as specified in [docs/sytest.md](https://github.com/matrix-org/dendrite/blob/master/docs/sytest.md) +* [ ] 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) |