summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorKevin Krakauer <krakauer@google.com>2021-07-14 10:51:47 -0700
committerKevin Krakauer <krakauer@google.com>2021-07-14 13:10:55 -0700
commite55fb66ecd9ffb5b87e9cdf3171f3fbdf8c9048e (patch)
treec3673a9fcc6bdf568b12c44d34021cdeb4228fa4
parent85a0a353ad185946d39463fddb3ec2cb37876371 (diff)
use github issue templates
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md30
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.yml67
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md20
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.yml24
4 files changed, 91 insertions, 50 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index f7a6112fd..000000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,30 +0,0 @@
----
-name: Bug report
-about: Create a bug report to help us improve
-title:
-labels: 'type: bug'
-assignees: ''
----
-
-**Description**
-
-A clear description of what the bug is. If possible, explicitly indicate the
-expected behavior vs. the observed behavior.
-
-**Steps to reproduce**
-
-If available, please include detailed reproduction steps.
-
-If the bug requires software that is not publicly available, see if it can be
-reproduced with software that is publicly available.
-
-**Environment**
-
-Please include the following details of your environment:
-
-* `runsc -version`
-* `docker version` or `docker info` (if available)
-* `kubectl version` and `kubectl get nodes` (if using Kubernetes)
-* `uname -a`
-* `git describe` (if built from source)
-* `runsc` debug logs (if available)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 000000000..f096ad598
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,67 @@
+name: Bug report
+description: Create a bug report to help us improve
+labels:
+ - 'type: bug'
+body:
+ - type: textarea
+ id: description
+ attributes:
+ label: Description
+ description: >
+ A clear description of the bug. If possible, explicitly indicate the
+ expected behavior vs. the observed behavior.
+ placeholder: Describe the problem.
+ validations:
+ required: true
+ - type: textarea
+ id: repro
+ attributes:
+ label: Steps to reproduce
+ description: >
+ If available, please include detailed reproduction steps.
+
+ If the bug requires software that is not publicly available, see if it
+ can be reproduced with software that is publicly available.
+ placeholder: How can others reproduce the issue?
+ - type: markdown
+ attributes:
+ value: |
+ # Environment
+
+ Please include the following details of your environment.
+ - type: textarea
+ id: runscVersion
+ attributes:
+ label: "runsc version"
+ placeholder: "`runsc -version`"
+ render: shell
+ - type: textarea
+ id: docker
+ attributes:
+ label: "docker version (if using docker)"
+ placeholder: "`docker version` or `docker info`"
+ render: shell
+ - type: input
+ id: uname
+ attributes:
+ label: "uname"
+ placeholder: "`uname -a`"
+ - type: textarea
+ id: kubectl
+ attributes:
+ label: "kubectl (if using Kubernetes)"
+ placeholder: "`kubectl version` and `kubectl get nodes`"
+ render: shell
+ - type: input
+ id: gitDescribe
+ attributes:
+ label: "repo state (if built from source)"
+ placeholder: "`git describe`"
+ - type: textarea
+ id: runscLogs
+ attributes:
+ label: "runsc debug logs (if available)"
+ description: >
+ See the [debug guide](https://gvisor.dev/docs/user_guide/debugging/)
+ to learn about logging.
+ render: shell
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
deleted file mode 100644
index 9acc45574..000000000
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ /dev/null
@@ -1,20 +0,0 @@
----
-name: Feature request
-about: Suggest an idea or improvement
-title: ''
-labels: 'type: enhancement'
-assignees: ''
----
-
-**Description**
-
-A clear description of the feature or enhancement.
-
-**Is this feature related to a specific bug?**
-
-Please include a bug references if yes.
-
-**Do you have a specific solution in mind?**
-
-Please include any details about a solution that you have in mind, including any
-alternatives considered.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 000000000..5073aba8b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,24 @@
+name: Feature request
+description: Suggest an idea or improvement
+labels:
+ - 'type: enhancement'
+body:
+ - type: textarea
+ id: description
+ attributes:
+ label: Description
+ placeholder: A clear description of the feature or enhancement.
+ validations:
+ required: true
+ - type: textarea
+ id: related
+ attributes:
+ label: Is this feature related to a specific bug?
+ description: Please include a bug references if yes.
+ - type: textarea
+ id: solution
+ attributes:
+ label: Do you have a specific solution in mind?
+ description: >
+ Please include any details about a solution that you have in mind,
+ including any alternatives considered.