issue templates (#733)

vercel · Apr 20, 2022 · a40cefc · a40cefc · vercel · Apr 20, 2022
1 parent 66e3269
commit a40cefc
Show file tree

Hide file tree

Showing 5 changed files with 165 additions and 0 deletions.
diff --git a/ISSUE_TEMPLATE/1.core_bug_report.yml b/ISSUE_TEMPLATE/1.core_bug_report.yml
@@ -0,0 +1,55 @@
+name: Core package Bug Report
+description: Create a bug report for the Next.js commerce core package
+labels: 'template: core bug'
+body:
+  - type: markdown
+    attributes:
+      value: Thanks for taking the time to file a bug report! Please fill out this form as completely as possible.
+  - type: checkboxes
+    attributes:
+      label: Verify latest commit
+      description: `main` is the latest version of Next.js Commerce.
+      options:
+        - label: I verified that the issue exists on `main`
+          required: true
+  - type: textarea
+    attributes:
+      label: Provide environment information
+      description: Please run `npx --no-install next info` in the root directory of your project and paste the results.
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: What browser are you using? (if relevant)
+      description: 'Please specify the exact version. For example: Chrome 100.0.4878.0'
+  - type: input
+    attributes:
+      label: How are you deploying your application? (if relevant)
+      description: 'For example: next start, next export, Vercel, Other platform'
+  - type: textarea
+    attributes:
+      label: Describe the Bug
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: To Reproduce
+      description: Steps to reproduce the behavior, please provide a clear code snippets that always reproduces the issue or a GitHub repository. Screenshots can be provided in the issue body below.
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: Before posting the issue go through the steps you've written down to make sure the steps provided are detailed and clear.
+  - type: markdown
+    attributes:
+      value: Contributors should be able to follow the steps provided in order to reproduce the bug.
+  - type: markdown
+    attributes:
+      value: These steps are used to add integration tests to ensure the same issue does not happen again. Thanks in advance!
diff --git a/ISSUE_TEMPLATE/2.provider_bug_report.yml b/ISSUE_TEMPLATE/2.provider_bug_report.yml
@@ -0,0 +1,59 @@
+name: Provider package Bug Report
+description: Create a bug report for the Next.js commerce core package
+labels: 'template: provider bug'
+body:
+  - type: markdown
+    attributes:
+      value: Thanks for taking the time to file a bug report! Please fill out this form as completely as possible.
+  - type: checkboxes
+    attributes:
+      label: Verify latest commit
+      description: `main` is the latest version of Next.js Commerce.
+      options:
+        - label: I verified that the issue exists on `main`
+          required: true
+  - type: textarea
+    attributes:
+      label: Provide environment information
+      description: Please run `npx --no-install next info` in the root directory of your project and paste the results.
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: What Provider are you using?
+      description: 'Please specify the provider package name. For example: `bigcommerce`'
+  - type: input
+    attributes:
+      label: What browser are you using? (if relevant)
+      description: 'Please specify the exact version. For example: Chrome 100.0.4878.0'
+  - type: input
+    attributes:
+      label: How are you deploying your application? (if relevant)
+      description: 'For example: next start, next export, Vercel, Other platform'
+  - type: textarea
+    attributes:
+      label: Describe the Bug
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: To Reproduce
+      description: Steps to reproduce the behavior, please provide a clear code snippets that always reproduces the issue or a GitHub repository. Screenshots can be provided in the issue body below.
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: Before posting the issue go through the steps you've written down to make sure the steps provided are detailed and clear.
+  - type: markdown
+    attributes:
+      value: Contributors should be able to follow the steps provided in order to reproduce the bug.
+  - type: markdown
+    attributes:
+      value: These steps are used to add integration tests to ensure the same issue does not happen again. Thanks in advance!
diff --git a/ISSUE_TEMPLATE/3.feature_request.yml b/ISSUE_TEMPLATE/3.feature_request.yml
@@ -0,0 +1,28 @@
+name: Feature Request
+description: Create a feature request for the Next.js core
+labels: 'template: story'
+body:
+  - type: markdown
+    attributes:
+      value: Thanks for taking the time to file a feature request! Please fill out this form as completely as possible.
+  - type: markdown
+    attributes:
+      value: 'Feature requests will be converted to the GitHub Discussions "Ideas" section.'
+  - type: textarea
+    attributes:
+      label: Describe the feature you'd like to request
+      description: A clear and concise description of what you want and what your use case is.
+    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
diff --git a/ISSUE_TEMPLATE/4.docs_request.yml b/ISSUE_TEMPLATE/4.docs_request.yml
@@ -0,0 +1,18 @@
+name: 'Docs Request for an Update or Improvement'
+description: A request to update or improve Next.js Commerce documentation
+title: 'Docs: '
+labels:
+  - 'template: documentation'
+body:
+  - type: textarea
+    attributes:
+      label: What is the improvement or update you wish to see?
+      description: 'Example: I would like to see more examples of how to use hooks.'
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Is there any context that might help us understand?
+      description: A clear description of any added context that might help us understand.
+    validations:
+      required: true
diff --git a/ISSUE_TEMPLATE/config.yml b/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Ask a question
+    url: https://github.com/vercel/commerce/discussions
+    about: Ask questions and discuss with other community members