- Clean up spacing

- Rearrange sections - Use placeholder vs value for optional configuration inputs - Remove note on CLI repo - can add in future, if needed
aws-amplify · Mar 3, 2021 · 66a8686 · 66a8686
1 parent 7a15725
commit 66a8686
Showing 1 changed file with 94 additions and 90 deletions.
diff --git a/.github/ISSUE_TEMPLATE/new_bug_report.yaml b/.github/ISSUE_TEMPLATE/new_bug_report.yaml
@@ -3,13 +3,10 @@ description: Create a report to help us improve Amplify JS
 title: ''
 issue_body: true
 body:
-  - type: markdown
-    attributes:
-      value: Thanks for taking the time to fill out this bug report! Try to include as much information as you can.
   - type: markdown
     attributes:
       value: |
-        > **Note**: If your issue is regarding the AWS Amplify CLI, please log it in the [Amplify CLI GitHub Issue Tracker](https://github.com/aws-amplify/amplify-cli/issues).
+        Thanks for taking the time to fill out this bug report! Try to include as much information as you can.
   - type: checkboxes
     attributes:
       label: |
@@ -21,6 +18,10 @@ body:
           required: true
         - label: I have done my best to include a minimal, self-contained set of instructions for consistently reproducing the issue.
           required: true
+  - type: markdown
+    attributes:
+      value: |
+        ---
   - type: checkboxes
     attributes:
       label: Is this a production issue?
@@ -32,20 +33,6 @@ body:
     attributes:
       value: |
         ## Environment
-  - type: textarea
-    attributes:
-      label: Environment information
-      description: |
-        Please run the following command inside your project and copy/paste the output below:
-        ```
-        npx envinfo --system --binaries --browsers --npmPackages --npmGlobalPackages
-        ```
-    validations:
-      required: true
-  - type: markdown
-    attributes:
-      value: |
-        ## Configuration
   - type: dropdown
     attributes:
       label: JavaScript Framework
@@ -60,24 +47,6 @@ body:
         - Not applicable
     validations:
       required: true
-  - type: dropdown
-    attributes:
-      label: Amplify Categories
-      description: |
-        What [Amplify categories](https://github.com/aws-amplify/amplify-cli#category-specific-commands) are being used?
-      multiple: true
-      options:
-        - auth
-        - storage
-        - function
-        - api
-        - analytics
-        - hosting
-        - notifications
-        - interactions
-        - predictions
-        - xr
-        - Not applicable
   - type: dropdown
     attributes:
       label: Amplify APIs
@@ -100,63 +69,39 @@ body:
         - Not applicable
     validations:
       required: true
-  - type: textarea
-    attributes:
-      label: aws-exports
-      description: If applicable, please provide your `aws-exports.js` file.
-      value: |
-        ```javascript
-          // -- If not provided, please remove placeholder below --
-          const awsmobile = {
-              "aws_project_region": "us-east-1",
-              "aws_cognito_identity_pool_id": "us-east-1:xxx-xxxx-xxxx-xxxx-xxxxxxxx",
-              "aws_cognito_region": "us-east-1",
-              "aws_user_pools_id": "us-east-1_xxx",
-              "aws_user_pools_web_client_id": "xxxx",
-              "oauth": {}
-          };
-        ```
-  - type: textarea
+  - type: dropdown
     attributes:
-      label: Manual configuration
-      description: If applicable, please provide your **manual configuration** example.
-      value: |
-        ```json
-          // -- If not provided, please remove placeholder below -- 
-          {
-            Auth: {
-                identityPoolId: 'XX-XXXX-X:XXXXXXXX-XXXX-1234-abcd-1234567890ab',
-                region: 'XX-XXXX-X',
-                identityPoolRegion: 'XX-XXXX-X',
-                userPoolId: 'XX-XXXX-X_abcd1234',
-                userPoolWebClientId: 'a1b2c3d4e5f6g7h8i9j0k1l2m3',
-                mandatorySignIn: false,
-                authenticationFlowType: 'USER_PASSWORD_AUTH',
-                oauth: {
-                    domain: 'your_cognito_domain',
-                    scope: ['phone', 'email', 'profile', 'openid', 'aws.cognito.signin.user.admin'],
-                    redirectSignIn: 'http://localhost:3000/',
-                    redirectSignOut: 'http://localhost:3000/',
-                    responseType: 'code' // or 'token', note that REFRESH token will only be generated when the responseType is code
-                  }
-              }
-          }
-        ```
+      label: Amplify Categories
+      description: |
+        What [Amplify categories](https://github.com/aws-amplify/amplify-cli#category-specific-commands) are being used?
+      multiple: true
+      options:
+        - auth
+        - storage
+        - function
+        - api
+        - analytics
+        - hosting
+        - notifications
+        - interactions
+        - predictions
+        - xr
+        - Not applicable
   - type: textarea
     attributes:
-      label: Additional configuration
+      label: Environment information
       description: |
-        If applicable, provide more configuration data. 
-
-        For example, for Amazon Cognito, run `aws cognito-idp describe-user-pool --user-pool-id us-west-2_xxxxxx`. 
-
-        **Be sure to remove any sensitive data***
-
-      value: |
-        ```json
-
+        Please run the following command inside your project and copy/paste the output below:
+        ```
+        npx envinfo --system --binaries --browsers --npmPackages --npmGlobalPackages
+        ```
+      placeholder: |
+        ```
+        # Please format as code block
 
         ```
+    validations:
+      required: true
   - type: markdown
     attributes:
       value: |
@@ -202,15 +147,74 @@ body:
         For example, error messages, or stack traces.
 
         You can turn on the debug mode to provide more info for us 
-        by using the below statement in your app/
+        by using the below statement in your app.
 
         ```javascript
         window.LOG_LEVEL = 'DEBUG';
         ``` 
         **Be sure to remove any sensitive data.**
+      placeholder: |
+        ```
+        # Please format as code block
+        ```
+  - type: markdown
+    attributes:
       value: |
+        ## Configuration
+  - type: textarea
+    attributes:
+      label: aws-exports.js
+      description: If applicable, please provide your `aws-exports.js` file.
+      placeholder: |
+        ```javascript
+          const awsmobile = {
+              "aws_project_region": "us-east-1",
+              "aws_cognito_identity_pool_id": "us-east-1:xxx-xxxx-xxxx-xxxx-xxxxxxxx",
+              "aws_cognito_region": "us-east-1",
+              "aws_user_pools_id": "us-east-1_xxx",
+              "aws_user_pools_web_client_id": "xxxx",
+              "oauth": {}
+          };
+        ```
+  - type: textarea
+    attributes:
+      label: Manual configuration
+      description: If applicable, please provide your **manual configuration** example.
+      placeholder: |
+        ```json
+          {
+            Auth: {
+                identityPoolId: 'XX-XXXX-X:XXXXXXXX-XXXX-1234-abcd-1234567890ab',
+                region: 'XX-XXXX-X',
+                identityPoolRegion: 'XX-XXXX-X',
+                userPoolId: 'XX-XXXX-X_abcd1234',
+                userPoolWebClientId: 'a1b2c3d4e5f6g7h8i9j0k1l2m3',
+                mandatorySignIn: false,
+                authenticationFlowType: 'USER_PASSWORD_AUTH',
+                oauth: {
+                    domain: 'your_cognito_domain',
+                    scope: ['phone', 'email', 'profile', 'openid', 'aws.cognito.signin.user.admin'],
+                    redirectSignIn: 'http://localhost:3000/',
+                    redirectSignOut: 'http://localhost:3000/',
+                    responseType: 'code' // or 'token', note that REFRESH token will only be generated when the responseType is code
+                  }
+              }
+          }
         ```
-        # Put your logs below this line.
+  - type: textarea
+    attributes:
+      label: Additional configuration
+      description: |
+        If applicable, provide more configuration data. 
+
+        For example, for Amazon Cognito, run `aws cognito-idp describe-user-pool --user-pool-id us-west-2_xxxxxx`. 
+
+        **Be sure to remove any sensitive data***
+
+      placeholder: |
+        ```json
+
+
         ```
   - type: markdown
     attributes:
@@ -235,7 +239,7 @@ body:
   - type: markdown
     attributes:
       value: |
-        ## Additional information
+        ## Additional information and screenshots
   - type: markdown
     attributes:
       value: >