From fc27dc6e6473f2ce20e4d7119e74237736161e14 Mon Sep 17 00:00:00 2001 From: ivonGwy Date: Wed, 25 Oct 2023 14:36:36 +0800 Subject: [PATCH] Doc (#231) * add issue template --- .github/ISSUE_TEMPLATE/bug.yaml | 60 ++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/consultation.yaml | 0 .github/ISSUE_TEMPLATE/feature.yaml | 44 +++++++++++++++++ .github/config.yml | 0 4 files changed, 104 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yaml create mode 100644 .github/ISSUE_TEMPLATE/consultation.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature.yaml create mode 100644 .github/config.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml new file mode 100644 index 0000000..c21d7d8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -0,0 +1,60 @@ +name: Bug Report +description: File a bug report +title: "[Bug]: " +labels: ["bug"] +assignees: + - pycook +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: input + id: contact + attributes: + label: Contact Details + description: How can we get in touch with you if we need more info? + placeholder: ex. email@example.com + validations: + required: false + - type: dropdown + id: type + attributes: + label: bug is related to UI or API aspects? + multiple: true + options: + - UI + - API + - 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: version + attributes: + label: Version + description: What version of our software are you running? + default: 2.3.5 + validations: + required: true + - type: dropdown + id: browsers + attributes: + label: What browsers are you seeing the problem on? + multiple: true + options: + - Firefox + - Chrome + - Safari + - Microsoft Edge + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell diff --git a/.github/ISSUE_TEMPLATE/consultation.yaml b/.github/ISSUE_TEMPLATE/consultation.yaml new file mode 100644 index 0000000..e69de29 diff --git a/.github/ISSUE_TEMPLATE/feature.yaml b/.github/ISSUE_TEMPLATE/feature.yaml new file mode 100644 index 0000000..4e83058 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yaml @@ -0,0 +1,44 @@ +name: Feature wanted +description: A new feature would be good +title: "[Feature]: " +labels: ["feature"] +assignees: + - pycook +body: + - type: markdown + attributes: + value: | + Thank you for your feature suggestion; we will evaluate it carefully! + - type: input + id: contact + attributes: + label: Contact Details + description: How can we get in touch with you if we need more info? + placeholder: ex. email@example.com + validations: + required: false + - type: dropdown + id: type + attributes: + label: feature is related to UI or API aspects? + multiple: true + options: + - UI + - API + - type: textarea + id: describe the feature + attributes: + label: What is your advice? + description: Also tell us, what did you expect to happen? + placeholder: Tell us what you want! + value: "everyone wants this feature!" + validations: + required: true + - type: textarea + id: version + attributes: + label: Version + description: What version of our software are you running? + default: 2.3.5 + validations: + required: true diff --git a/.github/config.yml b/.github/config.yml new file mode 100644 index 0000000..e69de29