From 0f3bbe0e32c9966cc5869c3cf2cb6f85c4b519da Mon Sep 17 00:00:00 2001 From: Dane Pilcher Date: Tue, 14 May 2024 08:36:20 -0600 Subject: [PATCH] docs: add gen 2 issue report and update feature request (#840) --- .github/ISSUE_TEMPLATE/1.gen2_bug_report.yaml | 42 ++++++++++++++++ .github/ISSUE_TEMPLATE/2.feature_request.md | 20 -------- ...bug_report.yaml => 2.gen1_bug_report.yaml} | 4 +- .github/ISSUE_TEMPLATE/3.feature_request.yaml | 49 +++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ 5 files changed, 98 insertions(+), 22 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/1.gen2_bug_report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/2.feature_request.md rename .github/ISSUE_TEMPLATE/{1.bug_report.yaml => 2.gen1_bug_report.yaml} (97%) create mode 100644 .github/ISSUE_TEMPLATE/3.feature_request.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/1.gen2_bug_report.yaml b/.github/ISSUE_TEMPLATE/1.gen2_bug_report.yaml new file mode 100644 index 00000000..e976ad0e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1.gen2_bug_report.yaml @@ -0,0 +1,42 @@ +name: Gen 2 Bug Report +description: Create a report to help us improve Amplify Gen 2 Codegen +labels: ['pending-triage'] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: env + attributes: + label: Environment information + description: | + Please copy and paste output of the following command. This will be automatically formatted into code, so no need for backticks. + ```bash + npx ampx info + ``` + render: plain text + validations: + required: true + - type: textarea + id: env + attributes: + label: Codegen packages + description: | + Please copy and paste output of the following command. This will be automatically formatted into code, so no need for backticks. + ```bash + npm list @aws-amplify/graphql-generator + ``` + render: plain text + validations: + required: true + - type: textarea + id: description + attributes: + label: Description + description: | + Describe the bug + How can this bug be reproduced? + Please include any code snippets or screenshots that you think would be helpful! + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/2.feature_request.md b/.github/ISSUE_TEMPLATE/2.feature_request.md deleted file mode 100644 index 146660c8..00000000 --- a/.github/ISSUE_TEMPLATE/2.feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- - -name: Feature request -about: Suggest an idea for this project ----> **Note**: If your feature-request is not related to codegen packages in this repository, please log it in the - -> [official AWS Amplify CLI repo](https://github.com/aws-amplify/amplify-cli/issues). We value your feedback and will -> take them seriously. - -**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. diff --git a/.github/ISSUE_TEMPLATE/1.bug_report.yaml b/.github/ISSUE_TEMPLATE/2.gen1_bug_report.yaml similarity index 97% rename from .github/ISSUE_TEMPLATE/1.bug_report.yaml rename to .github/ISSUE_TEMPLATE/2.gen1_bug_report.yaml index 91eec24f..06396b09 100644 --- a/.github/ISSUE_TEMPLATE/1.bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/2.gen1_bug_report.yaml @@ -1,5 +1,5 @@ -name: Bug report -description: Create a report to help us improve Amplify Codegen +name: Gen 1 Bug report +description: Create a report to help us improve Gen 1 CLI Amplify Codegen body: - type: markdown attributes: diff --git a/.github/ISSUE_TEMPLATE/3.feature_request.yaml b/.github/ISSUE_TEMPLATE/3.feature_request.yaml new file mode 100644 index 00000000..ae55eeaf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3.feature_request.yaml @@ -0,0 +1,49 @@ +name: Feature request +description: Suggest an idea for the Amplify Codegen +labels: ['pending-triage'] + +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to submit a feature request! Try to include as much information as you can. + + - For **Amplify Backend** issues, please visit [amplify-backend](https://github.com/aws-amplify/amplify-backend/issues/new/choose) + - For **Amplify Hosting** issues, visit [amplify-hosting](https://github.com/aws-amplify/amplify-hosting/issues/new/choose) + - For **Amplify Codegen** issues, visit [amplify-codegen](https://github.com/aws-amplify/amplify-codegen/issues/new/choose) + - type: textarea + attributes: + label: Describe the feature you'd like to request + description: | + A clear and concise description of what you want to happen. Please include **any related issues**, documentation, etc. + validations: + required: true + - type: textarea + attributes: + label: Describe the solution you'd like + description: | + A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + attributes: + label: Describe alternatives you've considered + description: | + A clear and concise description of any alternative solutions or features you've considered. + validations: + required: true + - type: textarea + attributes: + label: Additional context + description: | + Add any other use cases or context about the feature request here. Please include any prototype, workaround, reference implementation, etc. + - type: checkboxes + attributes: + label: Is this something that you'd be interested in working on? + options: + - label: 👋 I may be able to implement this feature request + - type: checkboxes + attributes: + label: Would this feature include a breaking change? + options: + - label: ⚠️ This feature might incur a breaking change diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..e8598621 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: I want help writing my Amplify application + url: https://discord.com/invite/amplify + about: Check out the `*-help` channels on Amplify's community Discord to ask your questions about building applications with the CLI or other Amplify libraries.