ci: add issue template (#219)
This commit is contained in:
parent
ecbb1f1552
commit
b0a6736d05
67
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
Normal file
67
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
Normal file
@ -0,0 +1,67 @@
|
||||
name: Bug report
|
||||
description: Create a report to help us improve
|
||||
title: '[Bug]'
|
||||
labels:
|
||||
- bug
|
||||
assignees: pengzhanbo
|
||||
body:
|
||||
- type: checkboxes
|
||||
id: checklist
|
||||
attributes:
|
||||
label: Checklist
|
||||
description: |-
|
||||
Make SURE that you follow these statements.
|
||||
options:
|
||||
- label: I am using **LTS** version of Node.js.
|
||||
required: true
|
||||
|
||||
- label: I am using the **latest v2 version** of VuePress and VuePress official plugins.
|
||||
required: true
|
||||
|
||||
- label: I am using the **latest version** of vuepress-theme-plume and all plugins in this repo.
|
||||
required: true
|
||||
|
||||
- label: I followed the docs and I double checked my configuration.
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: package
|
||||
attributes:
|
||||
label: Package name
|
||||
description: Which package are you reporting
|
||||
value: vuepress-theme-plume
|
||||
placeholder: package name
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
id: operating-systems
|
||||
attributes:
|
||||
label: Which operating system are you using?
|
||||
description: You may select more than one. Don’t select anything if it's not about the environment.
|
||||
options:
|
||||
- label: macOS
|
||||
- label: Windows
|
||||
- label: Linux
|
||||
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
## Describe the bug
|
||||
|
||||
> If applicable, add screenshots and log to help explain your problem.
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Describe the bug
|
||||
description: A clear and concise description of what the bug is.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
attributes:
|
||||
label: Additional context
|
||||
description: If you are not reporting something obvious, a minimal reproduction repo and related log is required.
|
||||
placeholder: Add any other context about the problem here. Especially the issue occurs in certain OS, browser or configuration.
|
||||
67
.github/ISSUE_TEMPLATE/bug-report.zh-CN.yml
vendored
Normal file
67
.github/ISSUE_TEMPLATE/bug-report.zh-CN.yml
vendored
Normal file
@ -0,0 +1,67 @@
|
||||
name: 问题报告
|
||||
description: 创建一份问题报告以帮助我们改进
|
||||
title: '[Bug]'
|
||||
labels:
|
||||
- bug
|
||||
assignees: pengzhanbo
|
||||
body:
|
||||
- type: checkboxes
|
||||
id: checklist
|
||||
attributes:
|
||||
label: 检查清单
|
||||
description: |-
|
||||
确保你遵循以下陈述。
|
||||
options:
|
||||
- label: 我正在使用**LTS**版本的Node.js。
|
||||
required: true
|
||||
|
||||
- label: 我正在使用 **最新 v2 版本** 的 VuePress 和 VuePress 官方插件。
|
||||
required: true
|
||||
|
||||
- label: 我正在使用此仓库中的 **最新版本** 的 vuepress-theme-plume 及其所有插件。
|
||||
required: true
|
||||
|
||||
- label: 我按照文档操作,并仔细检查了我的配置。
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: package
|
||||
attributes:
|
||||
label: 包名
|
||||
description: 您要报告哪个包
|
||||
value: vuepress-theme-plume
|
||||
placeholder: package name
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
id: operating-systems
|
||||
attributes:
|
||||
label: 你正在使用哪个操作系统?
|
||||
description: 您可以选择多个选项。如果与环境无关,请不要选择任何选项。
|
||||
options:
|
||||
- label: macOS
|
||||
- label: Windows
|
||||
- label: Linux
|
||||
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
## 描述该错误
|
||||
|
||||
> 如有需要,请添加截图和日志以帮助解释您的问题。
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: 描述该错误
|
||||
description: 一个清晰简洁的错误描述。
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
attributes:
|
||||
label: 附加上下文
|
||||
description: 如果你报告的问题不明显,需要提供最小复现仓库及相关日志。
|
||||
placeholder: 在此添加有关问题的其他上下文信息。特别是问题在特定操作系统、浏览器或配置下出现。
|
||||
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@ -0,0 +1,5 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Questions about theme and plugins
|
||||
url: https://github.com/pengzhanbo/vuepress-theme-plume/discussions/new
|
||||
about: Please ask questions in Discussion.
|
||||
33
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
Normal file
33
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
Normal file
@ -0,0 +1,33 @@
|
||||
name: Feature request
|
||||
description: Suggest an idea for this project
|
||||
title: '[Feature Request]'
|
||||
labels:
|
||||
- enhancement
|
||||
assignees: pengzhanbo
|
||||
body:
|
||||
- type: checkboxes
|
||||
id: checklist
|
||||
attributes:
|
||||
label: Checklist
|
||||
description: Make sure that you follow these statements.
|
||||
options:
|
||||
- label: I searched existing issues and no one else requests similar feature.
|
||||
required: true
|
||||
|
||||
- label: I think that 25%+ users are positive towards this feature.
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: feature
|
||||
attributes:
|
||||
label: Describe the feature
|
||||
description: What's it for and why you want
|
||||
placeholder: A clear and concise description of what the feature is, and what it will enhance or solve. Ex. I'm always frustrated when [...]
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
attributes:
|
||||
label: Additional context
|
||||
placeholder: Add any other context or screenshots about the feature request here.
|
||||
33
.github/ISSUE_TEMPLATE/feature-request.zh-CN.yml
vendored
Normal file
33
.github/ISSUE_TEMPLATE/feature-request.zh-CN.yml
vendored
Normal file
@ -0,0 +1,33 @@
|
||||
name: 新功能建议
|
||||
description: 为该项目提出一个想法
|
||||
title: '[Feature Request]'
|
||||
labels:
|
||||
- enhancement
|
||||
assignees: pengzhanbo
|
||||
body:
|
||||
- type: checkboxes
|
||||
id: checklist
|
||||
attributes:
|
||||
label: 检查清单
|
||||
description: 确保遵循以下陈述。
|
||||
options:
|
||||
- label: 我搜索了现有问题,没有其他人请求类似功能。
|
||||
required: true
|
||||
|
||||
- label: 我认为25%以上的用户对此功能持积极态度。
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: feature
|
||||
attributes:
|
||||
label: 描述该功能
|
||||
description: 它有什么用,你为什么想要
|
||||
placeholder: 功能清晰简洁的描述,以及它将增强或解决的问题。例如,我总是感到困难,当 [...]
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
attributes:
|
||||
label: 附加上下文
|
||||
placeholder: 在此添加有关功能请求的任何其他上下文或截图。
|
||||
Loading…
x
Reference in New Issue
Block a user