Skip to content

BillionMail gives you open-source MailServer, NewsLetter, Email Marketing — fully self-hosted, dev-friendly, and free from monthly fees. Join the discord: https://discord.gg/asfXzBUhZr

Added issue templates.

Jack7e99bb38d73c
diff --git a/.github/ISSUE_TEMPLATE/00-bug.yaml b/.github/ISSUE_TEMPLATE/00-bug.yaml
new file mode 100644
index 00000000..814adedf
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/00-bug.yaml
@@ -0,0 +1,116 @@
+# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms
+# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
+name: Bugs
+description: Report a bug to help us improve
+title: "Bug title"
+labels:
+ - bug
+
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for helping us improve! 🙏 Please answer these questions and provide as much information as possible about your problem.
+
+ # 1. Environment Information (Structured)
+ - type: dropdown
+ id: os
+ attributes:
+ label: Operating System
+ description: Select or specify the exact distribution
+ options:
+ - Windows
+ - macOS
+ - Linux
+ - Other
+ validations:
+ required: true
+
+ - type: input
+ id: os_version
+ attributes:
+ label: OS Version
+ placeholder: e.g., "Ubuntu 22.04 LTS" or "Windows 11 23H2"
+ validations:
+ required: true
+
+ - type: dropdown
+ id: arch
+ attributes:
+ label: System Architecture
+ options:
+ - x86_64
+ - ARM64
+ - Other
+ validations:
+ required: true
+
+ # 2. Docker Environment
+ - type: input
+ id: docker_version
+ attributes:
+ label: Docker Version
+ placeholder: Output of `docker --version`
+ validations:
+ required: true
+
+ - type: input
+ id: compose_version
+ attributes:
+ label: Docker Compose Version
+ placeholder: Output of `docker-compose --version`
+ validations:
+ required: false
+
+ - type: checkboxes
+ id: reproduce_latest
+ attributes:
+ label: Reproducible in Latest Version?
+ options:
+ - label: "Yes, occurs in the latest stable release"
+ required: false
+ - label: "No, only in older versions (specify version)"
+ required: false
+
+ # 3. Core Bug Description (Required)
+ - type: textarea
+ id: steps
+ attributes:
+ label: Reproduction Steps
+ description: Clear sequence to trigger the bug (commands/operations)
+ placeholder: |
+ 1. Run `docker-compose up -d`
+ 2. Access http://localhost:8080
+ 3. ...
+ validations:
+ required: true
+
+ - type: textarea
+ id: observed
+ attributes:
+ label: Observed Behavior
+ description: Error logs, screenshots, or unexpected behavior
+ placeholder: |
+ - Container logs show `ERROR: Permission denied`
+ - Service returns 500 error with headers...
+ validations:
+ required: true
+
+ - type: textarea
+ id: expected
+ attributes:
+ label: Expected Behavior
+ description: Correct behavior or suggested fix
+ placeholder: "Service should return 200 status with JSON output"
+ validations:
+ required: true
+
+ # 4. Additional Context (Optional)
+ - type: textarea
+ id: additional
+ attributes:
+ label: Supplemental Information
+ placeholder: Relevant config snippets, stack traces, etc.
+ render: markdown
+ validations:
+ required: false
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/01-enhancement.yaml b/.github/ISSUE_TEMPLATE/01-enhancement.yaml
new file mode 100644
index 00000000..8ec92ec2
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/01-enhancement.yaml
@@ -0,0 +1,44 @@
+# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms
+# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
+name: Enhancement
+description: Suggest an idea for this project
+title: "A good idea"
+labels:
+ - Enhancement
+
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for helping us improve! 🙏 Please answer these questions and provide as much information as possible about your problem.
+
+ - type: dropdown
+ id: is-problem
+ attributes:
+ label: Is your feature request related to a problem?
+ options:
+ - Option Yes
+ - Option No
+ validations:
+ required: true
+
+ - type: textarea
+ id: description-solution
+ attributes:
+ label: "Describe the solution you'd like"
+ validations:
+ required: true
+
+ - type: textarea
+ id: description-considered
+ attributes:
+ label: "Describe alternatives you've considered"
+ validations:
+ required: true
+
+ - type: textarea
+ id: additional
+ attributes:
+ label: "Additional"
+ validations:
+ required: false
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/02-documentation.yaml b/.github/ISSUE_TEMPLATE/02-documentation.yaml
new file mode 100644
index 00000000..2837a51d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/02-documentation.yaml
@@ -0,0 +1,28 @@
+# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms
+# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
+name: Documentation
+description: Suggest improvements or additions to our documentation
+title: "A good idea"
+labels:
+ - documentation
+
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for helping us improve! 🙏 Please answer these questions and provide as much information as possible about your problem.
+
+ - type: textarea
+ id: description
+ attributes:
+ label: "Description"
+ description: "Please describe your idea in detail."
+ validations:
+ required: true
+
+ - type: textarea
+ id: additional
+ attributes:
+ label: "Additional"
+ validations:
+ required: false
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/03-question.yaml b/.github/ISSUE_TEMPLATE/03-question.yaml
new file mode 100644
index 00000000..87568d18
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/03-question.yaml
@@ -0,0 +1,21 @@
+# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms
+# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
+name: Questions
+description: I want to ask a question
+title: "Question title"
+labels:
+ - question
+
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Please read the document carefully.
+
+ - type: textarea
+ id: ask
+ attributes:
+ label: "What do you want to ask?"
+ description: "Please describe the details of your questions."
+ validations:
+ required: true
\ No newline at end of file