sdgoij/stalwart
1
0
Fork 0
mirror of https://github.com/stalwartlabs/stalwart.git synced 2026-03-17 14:34:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated issue templates

Browse Source
This commit is contained in:
mdecimus
2026-01-06 09:59:59 +01:00
parent 8b09a01c73
commit 131730540b
5 changed files with 205 additions and 132 deletions
Download Patch File Download Diff File Expand all files Collapse all files

157
.github/DISCUSSION_TEMPLATE/issue_triage.yml vendored Normal file
View File

@@ -0,0 +1,157 @@
labels: ["needs-confirmation"]
body:
- type: markdown
attributes:
value: |
> [!IMPORTANT]
> Please review the [documentation](https://stalw.art/docs/), check the [FAQ](https://stalw.art/docs/faq), and search existing [Discussions](https://github.com/stalwartlabs/stalwart/discussions) and [Issues](https://github.com/stalwartlabs/stalwart/issues?q=sort%3Areactions-desc) before opening a new Discussion.
>
> Most reported issues turn out to be configuration problems rather than actual bugs. Starting here helps us triage effectively—if this is confirmed as a bug, we'll create an Issue for tracking.
- type: markdown
attributes:
value: "# Issue Details"
- type: textarea
attributes:
label: Issue Description
description: |
Provide a detailed description of the issue. Include relevant information, such as:
- The feature or configuration you encounter the issue with.
- Screenshots, logs, or other supporting information.
- If this is a regression of an existing issue that was closed or resolved, please include the previous reference (Discussion, Issue, PR, commit).
> [!TIP]
> **Not sure what information to include?**
> - **Authentication issues:** Include the authentication method (LDAP, OIDC, SQL, internal), relevant sanitized config snippets, and error messages from logs.
> - **Email delivery issues:** Include relevant SMTP logs (with `trace` level if possible), sender/recipient domains, and any bounce messages.
> - **IMAP/JMAP issues:** Include the client being used, the specific operation failing, and relevant protocol logs.
> - **Performance issues:** Include server specs, number of accounts/messages, and resource usage metrics.
placeholder: |
When trying to send an email via SMTP, the connection is accepted but the message is rejected with error 550.
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: |
Describe how you expect Stalwart to behave in this situation. Include any relevant documentation links.
placeholder: |
The email should be accepted and delivered to the recipient's mailbox.
validations:
required: false
- type: textarea
attributes:
label: Actual Behavior
description: |
Describe how Stalwart actually behaves in this situation. If it is not immediately obvious how the actual behavior differs from the expected behavior described above, please mention the deviation specifically.
placeholder: |
The email is rejected with error: "550 5.7.1 Relay access denied"
validations:
required: false
- type: textarea
attributes:
label: Reproduction Steps
description: |
Provide a detailed set of step-by-step instructions for reproducing this issue.
placeholder: |
1. Configure Stalwart with the attached configuration.
2. Attempt to send an email from user@example.com to external@domain.com.
3. Observe the 550 error in the SMTP session.
validations:
required: true
- type: textarea
attributes:
label: Relevant Log Output
description: |
Please copy and paste any relevant log output. Set logging level to `trace` if you can't find any relevant errors in the log.
render: shell
- type: dropdown
attributes:
label: Stalwart Version
description: What version of Stalwart are you running?
options:
- v0.15.x
- v0.14.x
- v0.13.x
- v0.12.x or lower
validations:
required: true
- type: dropdown
attributes:
label: Installation Method
description: How did you install Stalwart?
options:
- Docker
- Binary (Linux)
- Binary (macOS)
- Binary (FreeBSD)
- Binary (Windows)
- NixOS
- Built from source
validations:
required: true
- type: dropdown
attributes:
label: Database Backend
description: What database are you using for the data store?
options:
- RocksDB
- FoundationDB
- PostgreSQL
- MySQL
- SQLite
validations:
required: false
- type: dropdown
attributes:
label: Blob Storage
description: What blob storage are you using?
options:
- RocksDB
- FoundationDB
- PostgreSQL
- MySQL
- SQLite
- Filesystem
- S3-compatible
- Azure
validations:
required: false
- type: dropdown
attributes:
label: Directory Backend
description: Where is your directory/user database located?
options:
- Internal
- SQL
- LDAP
- OIDC
validations:
required: false
- type: textarea
attributes:
label: Additional Context
description: |
Add any other context about the problem here. This could include:
- Client software and versions (Thunderbird, Apple Mail, K-9, etc.)
- Proxy or reverse proxy configuration (nginx, Traefik, etc.)
- Network setup (NAT, firewall rules, etc.)
validations:
required: false
- type: markdown
attributes:
value: |
# Acknowledgements
> [!TIP]
> Use these links to review existing [Discussions](https://github.com/stalwartlabs/stalwart/discussions) and [Issues](https://github.com/stalwartlabs/stalwart/issues?q=sort%3Areactions-desc).
- type: checkboxes
attributes:
label: "I acknowledge that:"
options:
- label: I have reviewed the documentation and FAQ and confirm that my issue is NOT addressed there.
required: true
- label: I have searched the Stalwart repository (both open and closed Discussions and Issues) and confirm this is not a duplicate.
required: true
- label: I have set the logging level to `trace` and included relevant log output if applicable.
required: false
- label: I agree to follow the project's [Code of Conduct](https://github.com/stalwartlabs/.github/blob/main/CODE_OF_CONDUCT.md).
required: true

96
.github/ISSUE_TEMPLATE/bug_report.yml vendored
View File

@@ -1,96 +0,0 @@
name: I found a bug
description: Most reported issues turn out to be configuration problems rather than actual bugs. If you are not 100% certain this is a bug, please start a new discussion instead.
title: "🪲: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report! Most reported issues turn out to be configuration problems rather than actual bugs. If you are not 100% certain this is a bug, please start a new [discussion](https://github.com/stalwartlabs/stalwart/discussions/new?category=q-a) instead.
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: How can we reproduce the problem?
description: Please provide detailed steps for reproducing the problem.
placeholder: Tell us how to reproduce the problem!
value: "I can reproduce the problem by doing the following steps:"
validations:
required: true
- type: dropdown
id: version
attributes:
label: Version
description: What version of our software are you running?
options:
- v0.15.x
- v0.14.x
- v0.13.x
- v0.12.x or lower
validations:
required: true
- type: dropdown
id: db
attributes:
label: What database are you using?
options:
- RocksDB
- FoundationDB
- PostgreSQL
- mySQL
- SQLite
- type: dropdown
id: blob
attributes:
label: What blob storage are you using?
options:
- RocksDB
- FoundationDB
- PostgreSQL
- mySQL
- SQLite
- Filesystem
- S3-compatible
- Azure
- type: dropdown
id: directory
attributes:
label: Where is your directory located?
options:
- Internal
- SQL
- LDAP
- OIDC
- type: dropdown
id: os
attributes:
label: What operating system are you using?
options:
- Linux
- Docker
- MacOS
- NixOS
- FreeBSD
- Windows
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output, set logging level to `trace` if you can't find any relevant errors in the log.
render: shell
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/stalwartlabs/.github/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true

10
.github/ISSUE_TEMPLATE/config.yml vendored
View File

@@ -1,8 +1,14 @@
blank_issues_enabled: false
contact_links:
- name: I have a question or problem
- name: Report an Issue
url: https://github.com/stalwartlabs/stalwart/discussions/new?category=issue-triage
about: Report a potential bug. Confirmed bugs will be converted to Issues.
- name: Questions & Support
url: https://github.com/stalwartlabs/stalwart/discussions/new?category=q-a
about: Before opening a discussion, please read the documentation at stalw.art/docs, use the search bar to check if your question has already been answered, and review your logs (using `trace` level) carefully as the solution might already be there. If you still need help after these steps, feel free to start a new discussion.
about: Get help with configuration, troubleshooting, or general questions.
- name: Feature Requests
url: https://github.com/stalwartlabs/stalwart/discussions/new?category=feature-requests-and-ideas
about: Suggest new features or improvements.
- name: Join Stalwart's Reddit
url: https://www.reddit.com/r/stalwartlabs
about: Join our subreddit for help, discussions and release announcements.

40
.github/ISSUE_TEMPLATE/confirmed_issue.yml vendored Normal file
View File

@@ -0,0 +1,40 @@
name: Confirmed Bug Report
description: Only for issues that have been discussed and confirmed as bugs in GitHub Discussions.
labels: ["bug"]
title: "🪲: "
body:
- type: markdown
attributes:
value: |
> [!IMPORTANT]
> This template is **only** for issues that have already been discussed and confirmed as bugs in the [Discussions](https://github.com/stalwartlabs/stalwart/discussions) section.
>
> If you haven't had your issue confirmed yet, please [start a Discussion](https://github.com/stalwartlabs/stalwart/discussions/new?category=q-a) first.
- type: input
attributes:
label: Discussion Link
description: Provide the link to the Discussion where this issue was confirmed as a bug.
placeholder: https://github.com/stalwartlabs/stalwart/discussions/1234
validations:
required: true
- type: textarea
attributes:
label: Bug Summary
description: Brief summary of the confirmed bug.
validations:
required: true
- type: textarea
attributes:
label: Additional Information
description: |
Include any additional information not covered in the original Discussion, such as new findings, workarounds discovered, or updated reproduction steps.
validations:
required: false
- type: checkboxes
attributes:
label: Confirmation
options:
- label: This issue was discussed and confirmed as a bug in the linked Discussion.
required: true
- label: I have included the link to the Discussion above.
required: true

34
.github/ISSUE_TEMPLATE/feature_request.yml vendored
View File

@@ -1,34 +0,0 @@
name: I have a feature request
description: File a feature request issue
title: "🚀: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request form! Use this form only for requesting new features. If you have a question or problem, please use the [Q&A discussion](https://github.com/stalwartlabs/stalwart/discussions/new?category=q-a).
- type: textarea
id: request
attributes:
label: Which feature or improvement would you like to request?
description: Write a clear and concise description of what you want to happen.
placeholder: "I'd like to see this feature:"
value: "I'd like to see this feature:"
validations:
required: true
- type: textarea
id: problem-related
attributes:
label: Is your feature request related to a problem?
description: Write a clear and concise description of what the problem is.
placeholder: Tell us what the problem is!
value: "I'm having a problem with..."
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/stalwartlabs/.github/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true