From 4dc4029238714ad3171fd2c51217775492d78f24 Mon Sep 17 00:00:00 2001 From: ddiu8081 Date: Sun, 30 Apr 2023 01:03:28 +0800 Subject: [PATCH] chore: add issue & pr templates --- .../ISSUE_TEMPLATE/bug_report_when_use.yml | 62 +++++++++++++++++++ .../bus_report_when_deploying.yml | 47 ++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 11 ++++ .github/ISSUE_TEMPLATE/feature_request.yml | 27 ++++++++ .github/ISSUE_TEMPLATE/typo.yml | 15 +++++ .github/PULL_REQUEST_TEMPLATE.md | 18 ++++++ 6 files changed, 180 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report_when_use.yml create mode 100644 .github/ISSUE_TEMPLATE/bus_report_when_deploying.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/typo.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report_when_use.yml b/.github/ISSUE_TEMPLATE/bug_report_when_use.yml new file mode 100644 index 00000000..527d6d4c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report_when_use.yml @@ -0,0 +1,62 @@ +name: 🐞 Bug report (When using) +description: Report an issue or possible bug when using `anse.app` +labels: ['pending triage', 'use'] +body: + - type: markdown + attributes: + value: | + ### Before submitting... + Thanks for taking the time to fill out this bug report! Please confirm the following points before submitting: + + ✅ I am using Anse's **official site** ([anse.app](https://anse.app)) or a fork version that has not been modified much. + ✅ I have checked the bug was not already reported by searching on GitHub under issues. + ✅ Use English to ask questions. This allows more people to search and participate in the issue. + - type: input + id: os + attributes: + label: What operating system are you using? + placeholder: Mac, Windows, Linux + validations: + required: true + - type: input + id: browser + attributes: + label: What browser are you using? + placeholder: Chrome, Firefox, Safari + validations: + required: true + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + placeholder: Bug description + validations: + required: true + - type: dropdown + id: provider + attributes: + label: What provider are you using? + description: If the issue is related to a provider, please fill in this field. + options: + - N/A + - OpenAI + - Stable Diffusion + - Others (Specify in description) + - type: textarea + id: prompt + attributes: + label: What prompt did you enter? + description: If the issue is related to the prompt you entered, please fill in this field. + - type: textarea + id: console-logs + attributes: + label: Console Logs + description: Please check your browser and fill in the error message if it exists. + - type: checkboxes + id: will-pr + attributes: + label: Participation + options: + - label: I am willing to submit a pull request for this issue. + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bus_report_when_deploying.yml b/.github/ISSUE_TEMPLATE/bus_report_when_deploying.yml new file mode 100644 index 00000000..9d22749d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bus_report_when_deploying.yml @@ -0,0 +1,47 @@ +name: 🐞 Bug report (When self-deploying) +description: Report an issue or possible bug when deploy to your own server or cloud. +labels: ['pending triage', 'deploy'] +body: + - type: markdown + attributes: + value: | + ### Before submitting... + Thanks for taking the time to fill out this bug report! Please confirm the following points before submitting: + + ✅ I am using **latest version of Anse**. + ✅ I have checked the bug was not already reported by searching on GitHub under issues. + ✅ Use English to ask questions. This allows more people to search and participate in the issue. + - type: dropdown + id: server + attributes: + label: How is Anse deployed? + description: Select the used deployment method. + options: + - Node + - Docker + - Vercel + - Netlify + - Railway + - Others (Specify in description) + validations: + required: true + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + placeholder: Bug description + validations: + required: true + - type: textarea + id: console-logs + attributes: + label: Console Logs + description: Please check your browser and node console, fill in the error message if it exists. + - type: checkboxes + id: will-pr + attributes: + label: Participation + options: + - label: I am willing to submit a pull request for this issue. + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..448bac9e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: 📚 Documentation + url: https://docs.anse.app/ + about: Check the documentation for usage of Anse, or make improvements to it. + - name: ⏱️ Roadmap + url: https://github.com/orgs/anse-app/projects/2 + about: Explore upcoming features. + - name: 💬 Discussions + url: https://github.com/anse-app/anse/discussions + about: Use discussions if you have an idea for improvement or for asking questions. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..81ad703e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,27 @@ +name: 🚀 Feature request +description: Suggest a feature or an improvement +labels: ['enhancement'] +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to fill out this feature request! + - type: textarea + id: feature-description + attributes: + label: Describe the feature + description: A clear and concise description of what you think would be a helpful addition. + validations: + required: true + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Any other context or screenshots about the feature request here. + - type: checkboxes + id: will-pr + attributes: + label: Participation + options: + - label: I am willing to submit a pull request for this feature. + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/typo.yml b/.github/ISSUE_TEMPLATE/typo.yml new file mode 100644 index 00000000..bad50221 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/typo.yml @@ -0,0 +1,15 @@ +name: 👀 Typo / Grammar fix +description: You can just go ahead and send a PR! Thank you! +labels: [] +body: + - type: markdown + attributes: + value: | + ## PR Welcome! + + If the typo / grammar issue is trivial and straightforward, you can help by **directly sending a quick pull request**! + If you spot multiple of them, we suggest combining them into a single PR. Thanks! + - type: textarea + id: context + attributes: + label: Additional context \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..a07fc030 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,18 @@ + + +### Description + + + +### Linked Issues + + +### Additional context + + \ No newline at end of file