Skip to content

Commit

Permalink
Add an issue template for bug reports. (#695)
Browse files Browse the repository at this point in the history
  • Loading branch information
Gnuxie authored Jan 19, 2025
1 parent 0e2f81e commit 420aaff
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 0 deletions.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
name: Draupnir Bot Mode Bug Template
about: A template for a bug encountered in Bot Mode
title: "Draupnir will not X while using the Z command"
labels: ["bug"]
---

_It is not required to fill out each of these fields, your bug will still be
considered, even if you do not follow the template. However, please do try
provide as much detail as possible to save us time._

**How is Draupnir setup?**

_Try to include any details about non default configuration or any context to
its use that might be relevant to the issue. If Draupnir has crashed, then these
will be printed at the end of the log, you should copy that output here._

I was using Draupnir with the `roomStateBacking` store enabled. All other
configuration options were default.

**What were you trying to achieve?**

_Include details about what you were trying to accomplish without workarounds._

I was trying to ban a server from my rooms by using the ban command.

**What steps did you take to encounter the bug**

_Try to describe clear concise steps or any details about how you encountered
the bug._

1. I ran `!draupnir ban server.example.com coc spam` in the management room.
2. I checked my protected rooms
3. I could not see the server ACL event updating.

**What is the bug or what did you expect to happen instead?**

_Try describe the outcome you would expect, or explicitly state what the bug
is_.

I expected Draupnir to have changed the `m.room.server_acl` event and ban the
server from all my rooms.
6 changes: 6 additions & 0 deletions REUSE.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ SPDX-PackageName = "Draupnir"
SPDX-PackageSupplier = "Gnuxie <[email protected]>"
SPDX-PackageDownloadLocation = "https://github.com/the-draupnir-project/Draupnir"

[[annotations]]
path = ".github/ISSUE_TEMPLATE/bug-report.md"
precedence = "aggregate"
SPDX-FileCopyrightText = "Gnuxie <[email protected]>"
SPDX-License-Identifier = "CC0-1.0"

[[annotations]]
path = "tsconfig.json"
precedence = "aggregate"
Expand Down

0 comments on commit 420aaff

Please sign in to comment.