feat: add bug issue template, and config (#7)

* feat: add bug issue template, and config * fixup! feat: add bug issue template, and config * fixup! feat: add bug issue template, and config
npm · Sep 29, 2021 · 14f9f28 · 14f9f28
1 parent 674753a
commit 14f9f28
Show file tree

Hide file tree

Showing 5 changed files with 112 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -0,0 +1,52 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
+description: File a bug/issue
+title: "[BUG] <title>"
+labels: [Bug, Needs Triage]
+body:
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: Please [search here](./issues) to see if an issue already exists for your problem.
+    options:
+    - label: I have searched the existing issues
+      required: true
+- type: textarea
+  attributes:
+    label: Current Behavior
+    description: A clear & concise description of what you're experiencing.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Expected Behavior
+    description: A clear & concise description of what you expected to happen.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Steps To Reproduce
+    description: Steps to reproduce the behavior.
+    value: |
+      1. In this environment...
+      2. With this config...
+      3. Run '...'
+      4. See error...
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Environment
+    description: |
+      examples:
+        - **npm**: 7.6.3
+        - **Node**: 13.14.0
+        - **OS**: Ubuntu 20.04
+        - **platform**: Macbook Pro
+    value: |
+        - OS:
+        - Node:
+        - npm:
+  validations:
+    required: false
+
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,3 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
+blank_issues_enabled: true
diff --git a/lib/content/bug.yml b/lib/content/bug.yml
@@ -0,0 +1,52 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
+description: File a bug/issue
+title: "[BUG] <title>"
+labels: [Bug, Needs Triage]
+body:
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: Please [search here](./issues) to see if an issue already exists for your problem.
+    options:
+    - label: I have searched the existing issues
+      required: true
+- type: textarea
+  attributes:
+    label: Current Behavior
+    description: A clear & concise description of what you're experiencing.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Expected Behavior
+    description: A clear & concise description of what you expected to happen.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Steps To Reproduce
+    description: Steps to reproduce the behavior.
+    value: |
+      1. In this environment...
+      2. With this config...
+      3. Run '...'
+      4. See error...
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Environment
+    description: |
+      examples:
+        - **npm**: 7.6.3
+        - **Node**: 13.14.0
+        - **OS**: Ubuntu 20.04
+        - **platform**: Macbook Pro
+    value: |
+        - OS:
+        - Node:
+        - npm:
+  validations:
+    required: false
+
diff --git a/lib/content/config.yml b/lib/content/config.yml
@@ -0,0 +1,3 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
+blank_issues_enabled: true
diff --git a/lib/content/index.js b/lib/content/index.js
@@ -6,6 +6,8 @@ const fs = require('@npmcli/fs')
 const content = {
   '.eslintrc.js': './eslintrc.js',
   '.github/workflows/ci.yml': './ci.yml',
+  '.github/ISSUE_TEMPLATE/bug.yml': './bug.yml',
+  '.github/ISSUE_TEMPLATE/config.yml': './config.yml',
   '.gitignore': './gitignore',
   'LICENSE.md': './LICENSE.md',
 }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# This file is automatically added by @npmcli/template-oss. Do not edit.

		blank_issues_enabled: true