summaryrefslogtreecommitdiffstats
path: root/.github/ISSUE_TEMPLATE
diff options
context:
space:
mode:
Diffstat (limited to '.github/ISSUE_TEMPLATE')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md29
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.yml83
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.yml36
3 files changed, 119 insertions, 29 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 8a0d833..0000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,29 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve pkb_client
-title: ''
-labels: bug
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior.
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**pkb-client Command**
-Specify the exact command of pkb-client. **Make sure to anonymize your Porkbun API key and secret and your Porkbun domain/subdomain.**
-
-**Versions (please complete the following version information):**
- - pkb_client: [you can use `pip show pkb_client` to get the version]
-
-**Error message**
-The returned error message.
-
-**Additional context**
-Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 0000000..5b12aa8
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,83 @@
+name: Bug Report
+description: File a bug report
+title: "[Bug]: "
+labels: ["bug", "triage"]
+
+body:
+ - type: markdown
+ attributes:
+ value: "Thanks for taking the time to fill out this bug report!"
+
+ - type: textarea
+ id: system-os-info
+ attributes:
+ label: OS info
+ description: The operating system and version you are using.
+ placeholder: eg. Debian 12 , Ubuntu 23.10, Arch 6.6.3, Windows 10, MacOS 12
+ validations:
+ required: true
+
+ - type: textarea
+ id: version-info
+ attributes:
+ label: pkb_client version
+ description: The pkb_client version you are using.
+ placeholder: eg. v1.2
+ validations:
+ required: true
+
+ - type: textarea
+ id: bug-description
+ attributes:
+ label: Bug description
+ description: A clear and precise description of what the bug is.
+ placeholder: What happend?
+ validations:
+ required: true
+
+ - type: textarea
+ id: expected-description
+ attributes:
+ label: Expected behaviour description
+ description: A simple and precise description of the expected behavior.
+ placeholder: What should happend?
+ validations:
+ required: true
+
+ - type: textarea
+ id: logs
+ attributes:
+ label: Relevant log output
+ description: Please copy and paste any relevant log output.
+ render: shell
+ validations:
+ required: false
+
+ - type: textarea
+ id: reproduce-steps
+ attributes:
+ label: Steps to reproduce
+ description: Steps to reproduce the behavior.
+ placeholder: How can the error be reproduced?
+ validations:
+ required: true
+
+ - type: textarea
+ id: additional-context
+ attributes:
+ label: Additional context
+ description: All further information on the context of the bug that does not belong to the other sections, such as a workaround or already tested approaches to a solution.
+ placeholder: Is there any further context?
+ validations:
+ required: false
+
+ - type: checkboxes
+ id: checklist
+ attributes:
+ label: Checklist
+ description: Please check off the following checklist after you have performed the corresponding actions
+ options:
+ - label: I have checked for [existing Github issues](https://github.com/infinityofspace/pkb_client/issues) for the same bug.
+ required: true
+ - label: I have checked to see if there is newer current version that already fixes this error.
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 0000000..2b82445
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,36 @@
+name: Feature Request
+description: File a feature request
+title: "[Enhancement] "
+labels: ["enhancement"]
+
+body:
+ - type: markdown
+ attributes:
+ value: "Thanks for taking the time to fill out this feature request!"
+
+ - type: textarea
+ id: problem-description
+ attributes:
+ label: Problem description
+ description: Description of the problem that needs to be solved.
+ placeholder: What problem should be solved?
+ validations:
+ required: true
+
+ - type: textarea
+ id: solution-description
+ attributes:
+ label: Solution description
+ description: Description of a possible problem solution.
+ placeholder: Ideas for a solution?
+ validations:
+ required: false
+
+ - type: checkboxes
+ id: checklist
+ attributes:
+ label: Checklist
+ description: Please check off the following checklist after you have performed the corresponding actions
+ options:
+ - label: I have checked for [existing Github issues](https://github.com/infinityofspace/pkb_client/issues) for the same feature request.
+ required: true