From 2e21dee358361d9e2e498c2f71681b845b731656 Mon Sep 17 00:00:00 2001 From: Aditya Vats Date: Fri, 1 Oct 2021 04:00:33 +0530 Subject: [PATCH 1/4] Create issue templates using new github issue forms for better bug reporting, documentation issues and feature suggestions. --- .github/ISSUE_TEMPLATE/bug.yaml | 75 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/documentation.yaml | 32 ++++++++++ .github/ISSUE_TEMPLATE/feature.yaml | 33 ++++++++++ 3 files changed, 140 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yaml create mode 100644 .github/ISSUE_TEMPLATE/documentation.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature.yaml diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml new file mode 100644 index 00000000..e04f1b45 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -0,0 +1,75 @@ +name: "🐛 Bug Report" +description: "Submit a bug report to help us improve" +title: "🐛 Bug Report: " +labels: [bug] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out our bug report form 🙏 + - type: textarea + id: steps-to-reproduce + validations: + required: true + attributes: + label: "👟 Reproduction steps" + description: "How do you trigger this bug? Please walk us through it step by step." + placeholder: "When I ..." + - type: textarea + id: expected-behavior + validations: + required: true + attributes: + label: "👍 Expected behavior" + description: "What did you think would happen?" + placeholder: "It should ..." + - type: textarea + id: actual-behavior + validations: + required: true + attributes: + label: "👎 Actual Behavior" + description: "What did actually happen? Add screenshots, if applicable." + placeholder: "It actually ..." + - type: dropdown + id: appwrite-version + attributes: + label: "🎲 Appwrite version" + description: "What version of Appwrite are you running?" + options: + - Version 0.10.x + - Version 0.9.x + - Version 0.8.x + - Version 0.7.x + - Version 0.6.x + - Different version (specify in environment) + validations: + required: true + - type: dropdown + id: operating-system + attributes: + label: "💻 Operating system" + description: "What OS is your server / device running on?" + options: + - Linux + - MacOS + - Windows + - Something else + validations: + required: true + - type: textarea + id: enviromnemt + validations: + required: false + attributes: + label: "🧱 Your Environment" + description: "Is your environment customized in any way?" + placeholder: "I use Cloudflare for ..." + - type: checkboxes + id: no-duplicate-issues + attributes: + label: "👀 Have you spent some time to check if this issue has been raised before?" + description: "Have you Googled for a similar issue or checked our older issues for a similar bug?" + options: + - label: "I checked and didn't find similar issue" + required: true diff --git a/.github/ISSUE_TEMPLATE/documentation.yaml b/.github/ISSUE_TEMPLATE/documentation.yaml new file mode 100644 index 00000000..f072132b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yaml @@ -0,0 +1,32 @@ +name: "📚 Documentation" +description: "Report an issue related to documentation" +title: "📚 Documentation: " +labels: [documentation] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out our bug report form 🙏 + - type: textarea + id: issue-description + validations: + required: true + attributes: + label: "💭 Description" + description: "A clear and concise description of what the issue is." + placeholder: "Documentation should not ..." + - type: checkboxes + id: no-duplicate-issues + attributes: + label: "👀 Have you spent some time to check if this issue has been raised before?" + description: "Have you Googled for a similar issue or checked our older issues for a similar bug?" + options: + - label: "I checked and didn't find similar issue" + required: true + - type: checkboxes + id: read-code-of-conduct + attributes: + label: "🏢 Have you read the [Code of Conduct](https://github.com/appwrite/appwrite/blob/master/CODE_OF_CONDUCT.md)?" + options: + - label: "I read the Code of Conduct" + required: true diff --git a/.github/ISSUE_TEMPLATE/feature.yaml b/.github/ISSUE_TEMPLATE/feature.yaml new file mode 100644 index 00000000..5664ab9a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yaml @@ -0,0 +1,33 @@ +name: 🚀 Feature" +description: "Submit a proposal for a new feature" +title: "🚀 Feature: " +labels: [feature] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out our bug report form 🙏 + - type: textarea + id: feature-description + validations: + required: true + attributes: + label: "🔖 Feature description" + description: "A clear and concise description of what the feature is." + placeholder: "You should add ..." + - type: textarea + id: pitch + validations: + required: true + attributes: + label: "🎤 Pitch" + description: "Please explain why this feature should be implemented and how it would be used. Add examples, if applicable." + placeholder: "In my use-case, ..." + - type: checkboxes + id: no-duplicate-issues + attributes: + label: "👀 Have you spent some time to check if this issue has been raised before?" + description: "Have you Googled for a similar issue or checked our older issues for a similar bug?" + options: + - label: "I checked and didn't find similar issue" + required: true From c6324c58701a7d4185e4c6b2464752067fcb7ab3 Mon Sep 17 00:00:00 2001 From: Aditya Vats Date: Sat, 2 Oct 2021 02:22:38 +0530 Subject: [PATCH 2/4] Updated PR with some new changes and made utopia centric. --- .github/ISSUE_TEMPLATE/bug.yaml | 15 +++++++-------- .github/ISSUE_TEMPLATE/documentation.yaml | 3 ++- .github/ISSUE_TEMPLATE/feature.yaml | 6 +++--- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml index e04f1b45..cbfe449d 100644 --- a/.github/ISSUE_TEMPLATE/bug.yaml +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -34,15 +34,14 @@ body: - type: dropdown id: appwrite-version attributes: - label: "🎲 Appwrite version" - description: "What version of Appwrite are you running?" + label: "🎲 Utopia Storage Version" + description: "What version of Utopia Storage are you running?" options: - - Version 0.10.x - - Version 0.9.x - - Version 0.8.x - - Version 0.7.x - - Version 0.6.x - - Different version (specify in environment) + - Version 0.5.x + - Version 0.4.x + - Version 0.3.x + - Version 0.2.x + - Version 0.1.x validations: required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/documentation.yaml b/.github/ISSUE_TEMPLATE/documentation.yaml index f072132b..33ab2c27 100644 --- a/.github/ISSUE_TEMPLATE/documentation.yaml +++ b/.github/ISSUE_TEMPLATE/documentation.yaml @@ -26,7 +26,8 @@ body: - type: checkboxes id: read-code-of-conduct attributes: - label: "🏢 Have you read the [Code of Conduct](https://github.com/appwrite/appwrite/blob/master/CODE_OF_CONDUCT.md)?" + description: "This is our [Code of Conduct](https://github.com/appwrite/appwrite/blob/master/CODE_OF_CONDUCT.md)." + label: "🏢 Have you read the Code of Conduct?" options: - label: "I read the Code of Conduct" required: true diff --git a/.github/ISSUE_TEMPLATE/feature.yaml b/.github/ISSUE_TEMPLATE/feature.yaml index 5664ab9a..68e435b4 100644 --- a/.github/ISSUE_TEMPLATE/feature.yaml +++ b/.github/ISSUE_TEMPLATE/feature.yaml @@ -1,4 +1,4 @@ -name: 🚀 Feature" +name: 🚀 Feature description: "Submit a proposal for a new feature" title: "🚀 Feature: " labels: [feature] @@ -6,7 +6,7 @@ body: - type: markdown attributes: value: | - Thanks for taking the time to fill out our bug report form 🙏 + Thanks for taking the time to fill out our feature report form 🙏 - type: textarea id: feature-description validations: @@ -27,7 +27,7 @@ body: id: no-duplicate-issues attributes: label: "👀 Have you spent some time to check if this issue has been raised before?" - description: "Have you Googled for a similar issue or checked our older issues for a similar bug?" + description: "Have you Googled for a similar issue or checked our older issues for a similar feature suggestion?" options: - label: "I checked and didn't find similar issue" required: true From cf1d77820ce649934f1b36a160afadafcaeb24ea Mon Sep 17 00:00:00 2001 From: Aditya Vats Date: Thu, 14 Oct 2021 01:25:21 +0530 Subject: [PATCH 3/4] added COC changes --- .github/ISSUE_TEMPLATE/bug.yaml | 7 +++++++ .github/ISSUE_TEMPLATE/documentation.yaml | 9 ++++----- .github/ISSUE_TEMPLATE/feature.yaml | 7 +++++++ 3 files changed, 18 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml index cbfe449d..30641b60 100644 --- a/.github/ISSUE_TEMPLATE/bug.yaml +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -72,3 +72,10 @@ body: options: - label: "I checked and didn't find similar issue" required: true + - type: checkboxes + id: read-code-of-conduct + attributes: + label: "🏢 Have you read the Code of Conduct?" + options: + - label: "I have read the [Code of Conduct](https://github.com/appwrite/appwrite/blob/HEAD/CODE_OF_CONDUCT.md)" + required: true diff --git a/.github/ISSUE_TEMPLATE/documentation.yaml b/.github/ISSUE_TEMPLATE/documentation.yaml index 33ab2c27..7ba1fc9b 100644 --- a/.github/ISSUE_TEMPLATE/documentation.yaml +++ b/.github/ISSUE_TEMPLATE/documentation.yaml @@ -23,11 +23,10 @@ body: options: - label: "I checked and didn't find similar issue" required: true - - type: checkboxes - id: read-code-of-conduct - attributes: - description: "This is our [Code of Conduct](https://github.com/appwrite/appwrite/blob/master/CODE_OF_CONDUCT.md)." + - type: checkboxes + id: read-code-of-conduct + attributes: label: "🏢 Have you read the Code of Conduct?" options: - - label: "I read the Code of Conduct" + - label: "I have read the [Code of Conduct](https://github.com/appwrite/appwrite/blob/HEAD/CODE_OF_CONDUCT.md)" required: true diff --git a/.github/ISSUE_TEMPLATE/feature.yaml b/.github/ISSUE_TEMPLATE/feature.yaml index 68e435b4..026aa1f8 100644 --- a/.github/ISSUE_TEMPLATE/feature.yaml +++ b/.github/ISSUE_TEMPLATE/feature.yaml @@ -31,3 +31,10 @@ body: options: - label: "I checked and didn't find similar issue" required: true + - type: checkboxes + id: read-code-of-conduct + attributes: + label: "🏢 Have you read the Code of Conduct?" + options: + - label: "I have read the [Code of Conduct](https://github.com/appwrite/appwrite/blob/HEAD/CODE_OF_CONDUCT.md)" + required: true From faa68f54fb1e0cb51e46fc1c15c8bc97e47d3acc Mon Sep 17 00:00:00 2001 From: Aditya Vats Date: Thu, 14 Oct 2021 01:36:19 +0530 Subject: [PATCH 4/4] fixed spacing for YAML --- .github/ISSUE_TEMPLATE/bug.yaml | 6 +++--- .github/ISSUE_TEMPLATE/documentation.yaml | 6 +++--- .github/ISSUE_TEMPLATE/feature.yaml | 6 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml index 30641b60..e104b3c9 100644 --- a/.github/ISSUE_TEMPLATE/bug.yaml +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -72,9 +72,9 @@ body: options: - label: "I checked and didn't find similar issue" required: true - - type: checkboxes - id: read-code-of-conduct - attributes: + - type: checkboxes + id: read-code-of-conduct + attributes: label: "🏢 Have you read the Code of Conduct?" options: - label: "I have read the [Code of Conduct](https://github.com/appwrite/appwrite/blob/HEAD/CODE_OF_CONDUCT.md)" diff --git a/.github/ISSUE_TEMPLATE/documentation.yaml b/.github/ISSUE_TEMPLATE/documentation.yaml index 7ba1fc9b..eae8d780 100644 --- a/.github/ISSUE_TEMPLATE/documentation.yaml +++ b/.github/ISSUE_TEMPLATE/documentation.yaml @@ -23,9 +23,9 @@ body: options: - label: "I checked and didn't find similar issue" required: true - - type: checkboxes - id: read-code-of-conduct - attributes: + - type: checkboxes + id: read-code-of-conduct + attributes: label: "🏢 Have you read the Code of Conduct?" options: - label: "I have read the [Code of Conduct](https://github.com/appwrite/appwrite/blob/HEAD/CODE_OF_CONDUCT.md)" diff --git a/.github/ISSUE_TEMPLATE/feature.yaml b/.github/ISSUE_TEMPLATE/feature.yaml index 026aa1f8..09e0c5ec 100644 --- a/.github/ISSUE_TEMPLATE/feature.yaml +++ b/.github/ISSUE_TEMPLATE/feature.yaml @@ -31,9 +31,9 @@ body: options: - label: "I checked and didn't find similar issue" required: true - - type: checkboxes - id: read-code-of-conduct - attributes: + - type: checkboxes + id: read-code-of-conduct + attributes: label: "🏢 Have you read the Code of Conduct?" options: - label: "I have read the [Code of Conduct](https://github.com/appwrite/appwrite/blob/HEAD/CODE_OF_CONDUCT.md)"