Skip to content

Commit

Permalink
doc: 优化 github issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
Alessandro-Pang committed Jan 2, 2025
1 parent 9ed79b7 commit 25a6ba5
Show file tree
Hide file tree
Showing 5 changed files with 171 additions and 67 deletions.
132 changes: 94 additions & 38 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,94 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
name: '🐞 Bug report'
description: Create a report to help us improve.
title: '[Bug]: '
labels: ['status: waiting for maintainer']
body:
- type: markdown
attributes:
value: |
Report errors and exceptions found in the project.

Before submitting a new bug/issue, please check the links below to see if there is a solution or if the issue has already been reported:

在提交新 issue 之前,先通过以下链接检查是否存在相同问题:

> [Issues](https://github.com/Alessandro-Pang/vue-print-next/issues) | [Closed Issues](https://github.com/Alessandro-Pang/vue-print-next/issues?q=is%3Aissue+is%3Aclosed)
- type: textarea
id: description
attributes:
label: Describe the bug / 问题描述
placeholder: |
Please provide a clear and concise description of the bug you encountered. Include screenshots if they help explain the problem better.
请提供清晰简洁的问题描述。如果可以的话,请添加截图以便更好地说明问题。

If you need to share code, please use Markdown code block syntax as shown below:
如果包含代码块,请使用下面展示的 Markdown 代码块语法:

```javascript
// Your code here
```
validations:
required: true

- type: input
id: link
attributes:
label: Reproduction link / 复现链接
placeholder: |
Provide a link to a minimal reproduction of the issue, such as on CodeSandbox or StackBlitz.
CodeSandbox / StackBlitz / ...

提供一个最小复现问题的链接,例如 CodeSandbox 或 StackBlitz。
validations:
required: false

- type: textarea
id: steps
attributes:
label: Steps to Reproduce the Bug or Issue / 重现步骤
placeholder: |
List the steps to reproduce the bug. For example:
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error
validations:
required: false

- type: dropdown
id: version
attributes:
label: Version / 版本
options:
- Please select / 请选择
- 1.x
- 0.x
validations:
required: true

- type: checkboxes
id: OS
attributes:
label: OS / 操作系统
options:
- label: macOS
- label: Windows
- label: Linux
- label: Others / 其他
validations:
required: true

- type: checkboxes
id: Browser
attributes:
label: Browser / 浏览器
options:
- label: Chrome
- label: Edge
- label: Firefox
- label: Safari (Limited support / 有限支持)
- label: IE (Nonsupport / 不支持)
- label: Others / 其他
validations:
required: true
10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/custom.md

This file was deleted.

40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/docs_feedback.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: '📚 Docs Feedback'
description: Improve documentation to make it more user-friendly and accessible / 助力打造更易于上手操作以及便捷查阅的文档
labels: ['status: waiting for maintainer', 'docs-feedback']
title: '[docs] '
body:
- type: input
id: page-url
attributes:
label: Related Page / 相关页面
description: Which page of the documentation is this about? / 这是关于文档的哪个页面?
placeholder: https://alexpang.cn/vue-print-next/docs/
validations:
required: true
- type: dropdown
id: issue-kind
attributes:
label: Kind of Issue / 问题类型
description: What kind of problem are you facing? / 您遇到了什么类型的问题?
options:
- Unclear explanations / 解释不清
- Missing information / 信息缺失
- Broken demo / 示例损坏
- Other / 其他
validations:
required: true
- type: textarea
id: issue-description
attributes:
label: Issue Description / 问题描述
description: |
Let us know what went wrong when you were using this documentation and what we could do to improve it / 请告知您在使用此文档时遇到的问题以及我们可以改进的地方
placeholder: |
Please describe the issue in detail. / 请详细描述问题。
- type: textarea
id: context
attributes:
label: Context / 上下文
description: What are you trying to accomplish? Providing context helps us come up with a solution that is more useful in the real world / 您希望实现什么目标?提供上下文有助于我们提出更实用的解决方案
placeholder: |
Describe your goal or task. / 描述您的目标或任务。
39 changes: 20 additions & 19 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
name: '💡 Feature Request'
description: I have a suggestion (and may want to implement it) / 我有一个建议(或者想参与贡献)
title: '[Feat]: '
labels: ['status: waiting for maintainer']
body:
- type: textarea
id: description
attributes:
label: Describe the feature / 功能描述
validations:
required: true

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
- type: dropdown
attributes:
label: Are you willing to contribute? / 是否愿意参与贡献?
options:
- Please select / 请选择
- ✅ Yes / 是
- ❌ No / 否
validations:
required: true
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: '💬 Question'
description: Ask questions about the project / 提问关于项目的问题
title: '[Ques]: '
labels: ['status: waiting for maintainer']
body:
- type: textarea
id: description
attributes:
label: Describe the Question / 问题描述
placeholder: |
Please provide a clear and concise description of the question you have. / 请提供清晰简洁的问题描述。
Include any relevant context or details that might help in understanding your question. / 包含任何可能有助于理解您问题的相关背景或细节。
---


0 comments on commit 25a6ba5

Please sign in to comment.