From 4dd95f0d7ef8ab831b9659fd0932468367b6df5e Mon Sep 17 00:00:00 2001 From: ivonGwy Date: Wed, 25 Oct 2023 14:36:36 +0800 Subject: [PATCH 1/4] 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 From f1dd5ca074479bb58abf055bb9817ba9ec3634f6 Mon Sep 17 00:00:00 2001 From: ivonGwy Date: Wed, 25 Oct 2023 14:46:44 +0800 Subject: [PATCH 2/4] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 38 ---------------------------- .github/ISSUE_TEMPLATE/custom.md | 10 -------- 2 files changed, 48 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/custom.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 6e6ac4f..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: "☢️ bug" -assignees: ivonGwy, pycook - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md deleted file mode 100644 index 48d5f81..0000000 --- a/.github/ISSUE_TEMPLATE/custom.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Custom issue template -about: Describe this issue template's purpose here. -title: '' -labels: '' -assignees: '' - ---- - - From ebe9d1e29fa84f41cde2b11b5561b1e093a110a7 Mon Sep 17 00:00:00 2001 From: ivonGwy Date: Wed, 25 Oct 2023 14:54:23 +0800 Subject: [PATCH 3/4] Doc (#232) * fix bugs --- .github/ISSUE_TEMPLATE/config.yml | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..7684710 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,6 @@ +blank_issues_enabled: false +contact_links: + - name: veops official website + url: https://veops.cn/#hero + about: you can contact us here. + From 22989f8d5abc218b669aab13a1d5ab748667aed4 Mon Sep 17 00:00:00 2001 From: ivonGwy Date: Wed, 25 Oct 2023 15:52:12 +0800 Subject: [PATCH 4/4] Doc (#234) * final template --- .github/ISSUE_TEMPLATE/1bug.yaml | 60 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/2feature.yaml | 44 +++++++++++++++++ .github/ISSUE_TEMPLATE/3consultation.yaml | 36 ++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 -------- 4 files changed, 140 insertions(+), 20 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/1bug.yaml create mode 100644 .github/ISSUE_TEMPLATE/2feature.yaml create mode 100644 .github/ISSUE_TEMPLATE/3consultation.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/1bug.yaml b/.github/ISSUE_TEMPLATE/1bug.yaml new file mode 100644 index 0000000..67daf3d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1bug.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: aspects + attributes: + label: This bug is related to UI or API? + multiple: true + options: + - UI + - API + - type: textarea + id: 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: input + id: version + attributes: + label: Version + description: What version of our software are you running? + value: "newest" + 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/2feature.yaml b/.github/ISSUE_TEMPLATE/2feature.yaml new file mode 100644 index 0000000..e5ce323 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2feature.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: aspects + attributes: + label: feature is related to UI or API aspects? + multiple: true + options: + - UI + - API + - type: textarea + id: 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: input + id: version + attributes: + label: Version + description: What version of our software are you running? + value: "newest" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/3consultation.yaml b/.github/ISSUE_TEMPLATE/3consultation.yaml new file mode 100644 index 0000000..a5d76ee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3consultation.yaml @@ -0,0 +1,36 @@ +name: Help wanted +description: I have a question +title: "[help wanted]: " +labels: ["help wanted"] +assignees: + - pycook +body: + - type: markdown + attributes: + value: | + Please tell us what's you need! + - 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: textarea + id: question + attributes: + label: What is your question? + description: Also tell us, how can we help? + placeholder: Tell us what you need! + value: "i have a question!" + validations: + required: true + - type: input + id: version + attributes: + label: Version + description: What version of our software are you running? + value: "newest" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index c907eaf..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: "✏️ feature" -assignees: ivonGwy, pycook - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here.