浏览代码

Use github issue template forms (#83177)

Currently we use GitHub issue templates containing markdown for each
template. This was an improvement over the single issue template before
that, and there are several bits of information that we ask for, but
filling out the template is cumbersome because it is completely
markdown, and users often leave bits of markdown comments meant for them
to read in the resulting issue.

This commit converts the existing issue templates to use the new github
issue template forms. These are configured through yml, and present an
html form to the user that is customized for each issue type.
Ryan Ernst 3 年之前
父节点
当前提交
86174d6add

+ 0 - 44
.github/ISSUE_TEMPLATE/bug.md

@@ -1,44 +0,0 @@
----
-name: Bug
-about: "Report a confirmed bug. For unconfirmed bugs please
- visit https://discuss.elastic.co/c/elasticsearch"
-labels: ">bug,needs:triage"
-
----
-<!--
-GitHub is reserved for bug reports and feature requests; it is not the place
-for general questions. If you have a question or an unconfirmed bug , please
-visit the [forums](https://discuss.elastic.co/c/elasticsearch).  Please also
-check your OS is [supported](https://www.elastic.co/support/matrix#show_os).
-If it is not, the issue is likely to be closed.
-
-For security vulnerabilities please only send reports to security@elastic.co.
-See https://www.elastic.co/community/security for more information.
-
-Please fill in the following details to help us reproduce the bug:
--->
-
-**Elasticsearch version** (`bin/elasticsearch --version`):
-
-**Plugins installed**: []
-
-**JVM version** (`java -version`):
-
-**OS version** (`uname -a` if on a Unix-like system):
-
-**Description of the problem including expected versus actual behavior**:
-
-**Steps to reproduce**:
-
-Please include a *minimal* but *complete* recreation of the problem,
-including (e.g.) index creation, mappings, settings, query etc.  The easier
-you make for us to reproduce it, the more likely that somebody will take the
-time to look at it.
-
- 1.
- 2.
- 3.
-
-**Provide logs (if relevant)**:
-
-

+ 70 - 0
.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,70 @@
+name: Bug
+description: "Report a confirmed bug. For unconfirmed bugs please visit https://discuss.elastic.co/c/elasticsearch"
+labels: [">bug", "needs:triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Github is reserved for bug reports and feature requests; it is
+        not the place for general questions. If you have a question or
+        an unconfirmed bug, please visit the [forums](https://discuss.elastic.co/c/elasticsearch).
+        Please also check your OS is [supported](https://www.elastic.co/support/matrix#show_os).
+        If it is not, the issue is likely to be closed.
+
+        For security vulnerabilities please only send reports to security@elastic.co.
+        See https://www.elastic.co/community/security for more information.
+
+        Please fill in the following details to help us reproduce the bug:
+  - type: input
+    id: es_version
+    attributes:
+      label: Elasticsearch Version
+      description: The version of Elasticsearch you are running, found with `bin/elasticsearch --version`
+    validations:
+      required: true
+  - type: input
+    id: plugins
+    attributes:
+      label: Installed Plugins
+      description: Comma separated list of plugins that you have installed
+    validations:
+      required: false
+  - type: input
+    id: java_version
+    attributes:
+      label: Java Version
+      description: The version of Java Elasticsearch is running with, found with `java -version`
+      value: _bundled_
+    validations:
+      required: true
+  - type: input
+    id: os_version
+    attributes:
+      label: OS Version    
+      description: The version of your operating system, found with `uname -a` of on unix-like system
+    validations:
+      required: true
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem Description
+      description: A description of the problem including expected versus actual behavior
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to Reproduce
+      description: |
+        A minimal but complete recreation of the problem including (e.g.) index
+        creation, mappings, settings, query etc.  The easier you make for us to
+        reproduce it, the more likely that somebody will take the time to look at it.
+    validations:
+      required: true
+  - type: textarea
+    id: logs 
+    attributes:
+      label: Logs (if relevant)
+      description: Any log relevant log messages or snippets
+    validations:
+      required: false

+ 0 - 21
.github/ISSUE_TEMPLATE/feature-request.md

@@ -1,21 +0,0 @@
----
-name: Feature Request
-about: Request a new feature we haven't thought of
-labels: ">enhancement,needs:triage"
-
----
-<!--
-Please first search existing issues for the feature you are requesting;
-it may already exist, even as a closed issue.
--->
-
-<!--
-Describe the feature.
-
-Please give us as much context as possible about the feature. For example,
-you could include a story about a time when you wanted to use the feature,
-and also tell us what you had to do instead. The last part is helpful
-because it gives us an idea of how much harder your life is without the
-feature.
-
--->

+ 19 - 0
.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,19 @@
+name: Feature Request
+description: Request a new feature we haven't thought of
+labels: [">enhancement", "needs:triage"]
+body:
+  - type: markdown
+    attributes:
+      value: | 
+        Please first search existing issues for the feature you are requesting;
+        it may already exist, even as a closed issue.
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: |
+        Please give us as much context as possible about the feature. For example,
+        you could include a story about a time when you wanted to use the feature,
+        and also tell us what you had to do instead. The last part is helpful
+        because it gives us an idea of how much harder your life is without the
+        feature.

+ 0 - 28
.github/ISSUE_TEMPLATE/test-failure.md

@@ -1,28 +0,0 @@
----
-name: Test Failure
-about: A test failure in CI
-labels: ">test-failure"
-
----
-
-<!--
-Please fill out the following information, and ensure you have attempted
-to reproduce locally
--->
-
-**Build scan**:
-
-**Repro line**:
-
-**Reproduces locally?**:
-
-**Applicable branches**:
-
-**Failure history**:
-<!--
-Link to build stats and possible indication of when this started failing and how often it fails
-<https://build-stats.elastic.co/app/kibana>
--->
-**Failure excerpt**:
-
-

+ 52 - 0
.github/ISSUE_TEMPLATE/test-failure.yml

@@ -0,0 +1,52 @@
+name: Test Failure
+description: A test failure in CI
+labels: [">test-failure"]
+body:
+  - type: markdown
+    attributes:
+      value: Please fill out the following information, and ensure you have attempted to reproduce locally
+  - type: input
+    id: link
+    attributes:
+      label: CI Link
+      description: A link to a Gradle buildscan (preferred) or Jenkins job with the failure
+    validations:
+      required: true
+  - type: input
+    id: repro_line
+    attributes:
+      label: Repro line
+      description: The reproduce line from the build output
+    validations:
+      required: true
+  - type: dropdown
+    id: reproducible
+    attributes:
+      label: Does it reproduce?
+      options:
+        - "Yes"
+        - "No"
+        - "Didn't try"
+    validations:
+      required: true
+  - type: input
+    id: branches
+    attributes:
+      label: Applicable branches
+      description: Branch names this failure has occurred on 
+    validations:
+      required: true
+  - type: input
+    id: history
+    attributes:
+      label: Failure history
+      description: Link to build stats and possible indication of when this started failing and how often
+    validations:
+      required: false
+  - type: textarea
+    id: excerpt
+    attributes:
+      label: Failure excerpt
+      description: The error or exception that occurs
+    validations:
+      required: true