Improved title and description format in issue templates

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
This commit is contained in:
Florent Poinsard 2022-02-01 10:15:17 +01:00
Родитель 0fcfef59cf
Коммит 7453f4e2f9
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 87A9DEBFB0824A2D
3 изменённых файлов: 13 добавлений и 15 удалений

24
.github/ISSUE_TEMPLATE/bug_report.yml поставляемый
Просмотреть файл

@ -1,6 +1,6 @@
name: Bug Report
description: You're experiencing an issue with Vitess that is different than the documented behavior.
title: ""
title: "Bug Report: "
labels: ["Type: Bug", "Needs Triage"]
body:
- type: textarea
@ -9,7 +9,6 @@ body:
label: Overview of the Issue
description: A paragraph or two about the issue you're experiencing.
placeholder: Tell us what you see!
value: ""
validations:
required: true
@ -17,8 +16,9 @@ body:
id: reproduction-steps
attributes:
label: Reproduction Steps
description: A paragraph or two about the issue you're experiencing.
placeholder: |
description: |
A paragraph or two about the issue you're experiencing.
Example:
1. Deploy the following `vschema`:
```javascript
{
@ -45,7 +45,6 @@ body:
```
3. Run `SELECT...`
4. View error
value: ""
render: markdown
validations:
required: true
@ -54,14 +53,13 @@ body:
id: binary-version
attributes:
label: Binary Version
description: Tell us which version of Vitess you're using.
placeholder: |
example:
description: |
Tell us which version of Vitess you're using.
Example:
```sh
giaquinti@workspace:~$ vtgate --version
Version: a95cf5d (Git branch 'HEAD') built on Fri May 18 16:54:26 PDT 2018 by giaquinti@workspace using go1.10 linux/amd64
```
value: ""
render: shell
validations:
required: true
@ -70,12 +68,12 @@ body:
id: os-and-env
attributes:
label: Operating System and Environment details
description: OS, Architecture, and any other information you can provide about the environment.
placeholder: |
description: |
OS, Architecture, and any other information you can provide about the environment.
Example:
- Operating system (output of `cat /etc/os-release`)
- Kernel version (output of `uname -sr`)
- Architecture (output of `uname -m`)
value: ""
render: shell
validations:
required: true
@ -85,4 +83,4 @@ body:
attributes:
label: Log Fragments
description: Include appropriate log fragments. If the log is longer than a few dozen lines, please include the URL to the gist (https://gist.github.com/) of the log instead of posting it in the issue. This will be automatically formatted into code, so no need for backticks.
render: shell
render: shell

2
.github/ISSUE_TEMPLATE/feature_request.yml поставляемый
Просмотреть файл

@ -1,6 +1,6 @@
name: Feature Request
description: If you have something you think Vitess could improve or add support for.
title: ""
title: "Feature Request: "
labels: ["Type: Feature Request", "Needs Triage"]
body:
- type: markdown

2
.github/ISSUE_TEMPLATE/question.yml поставляемый
Просмотреть файл

@ -1,6 +1,6 @@
name: Question
description: If you have a question, please check out our other community resources instead of opening an issue.
title: ""
title: "Question: "
labels: ["Type: Question", "Needs Triage"]
body:
- type: markdown