From 757025f2cb094bc9a0be9ed250fedf0c02d0b1df Mon Sep 17 00:00:00 2001 From: ShortCipher5 Date: Mon, 13 Mar 2023 22:26:51 +0800 Subject: [PATCH] docs: github issue templates (#1551) --- .github/ISSUE_TEMPLATE/BUG-REPORT.yml | 58 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml | 36 ++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 +++ 3 files changed, 102 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/BUG-REPORT.yml create mode 100644 .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml new file mode 100644 index 0000000000..14d5f7b41f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml @@ -0,0 +1,58 @@ +name: Bug Report +description: File a bug report +title: "bug: TITLE" +labels: ["bug", "product-review"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - 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! + validations: + required: true + - type: dropdown + id: version + attributes: + label: Version + description: What version of our software are you running? + options: + - app.affine.pro + - stage.affine.pro + validations: + required: true + - type: dropdown + id: browsers + attributes: + label: What browsers are you seeing the problem on? + multiple: true + options: + - Chrome + - Microsoft Edge + - Firefox + - Safari + - Other + - 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 + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + Tip: You can attach images here + - type: checkboxes + attributes: + label: Are you willing to submit a PR? + description: > + (Optional) We encourage you to submit a [Pull Request](https://github.com/toeverything/affine/pulls) (PR) to help improve AFFiNE for everyone, especially if you have a good understanding of how to implement a fix or feature. + See the AFFiNE [Contributing Guide](https://github.com/toeverything/affine/blob/master/CONTRIBUTING.md) to get started. + options: + - label: Yes I'd like to help by submitting a PR! diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml new file mode 100644 index 0000000000..5a964b22b2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml @@ -0,0 +1,36 @@ +name: Feature Request +description: Suggest a feature or improvement +title: "feat: TITLE" +labels: ["feat", "product-review"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this feature suggestion! + - type: textarea + id: description + attributes: + label: Description + description: What would you like to see added to AFFiNE? + placeholder: Please explain in details the feature and improvements you'd like to see. + validations: + required: true + - type: textarea + attributes: + label: Use case + description: | + How might this feature be used and who might use it. + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the idea you have! + Tip: You can attach images here + - type: checkboxes + attributes: + label: Are you willing to submit a PR? + description: > + (Optional) We encourage you to submit a [Pull Request](https://github.com/toeverything/affine/pulls) (PR) to help improve AFFiNE for everyone, especially if you have a good understanding of how to implement a fix or feature. + See the AFFiNE [Contributing Guide](https://github.com/toeverything/affine/blob/master/CONTRIBUTING.md) to get started. + options: + - label: Yes I'd like to help by submitting a PR! diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..2c9d414927 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: true +contact_links: + - name: Something else? + url: https://github.com/toeverything/AFFiNE/discussions + about: Feel free to ask and answer questions over in GitHub Discussions + - name: AFFiNE Community Support + url: https://community.affine.pro + about: AFFiNE Community - a place to ask, learn and engage with others