docs: update

This commit is contained in:
xrkffgg
2020-12-22 14:55:30 +08:00
parent 41f979f2ef
commit d70e5ec168
10 changed files with 657 additions and 78 deletions

24
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View File

@@ -0,0 +1,24 @@
---
name: 🐛 报告 bug
about: Report Bug.
title: '[BUG] Report bug'
labels: 'bug'
assignees:
---
### 🐛 Bug 描述 Bug description
<!-- 请在上方详细地描述 bug让大家都能理解。 -->
<!-- Please describe the bug in detail above so that everyone can understand. -->
### 🏞 期望结果 Desired result
<!-- 请在上方描述你原本期望看到的结果。 -->
<!-- Please describe above what you expected to see. -->
### 🚑 其他信息 Other information
<!-- 请在上方输入,如截图等其他信息。-->
<!-- Please enter other information such as screenshots above. -->
<!-- From: https://github.com/one-template/issue-template -->

View File

@@ -0,0 +1,24 @@
---
name: 🌟 需求、功能、建议
about: Needs, functions, suggestions.
title: '[Feature] New function'
labels: 'feature'
assignees:
---
### 🥰 需求描述 Description of Requirement
<!-- 请在上方详细地描述需求,让大家都能理解。 -->
<!-- Please describe you need in detail above so that everyone can understand. -->
### 🧐 解决方案 Solution
<!-- 如果你有解决方案,请在上方清晰地阐述。 -->
<!-- If you have a solution, please state it clearly above. -->
### 🚑 其他信息 Other information
<!-- 请在上方输入,如截图等其他信息。-->
<!-- Please enter other information such as screenshots above. -->
<!-- From: https://github.com/one-template/issue-template -->

24
.github/ISSUE_TEMPLATE/question.md vendored Normal file
View File

@@ -0,0 +1,24 @@
---
name: '❓ 疑问或需要帮助'
about: Question or need help
title: '[Question] Help'
labels: 'question'
assignees: ''
---
### 🧐 问题描述 Problem Description
<!-- 详细地描述问题,让大家都能理解。 -->
<!-- Describe the problem in detail so that everyone can understand. -->
### 💻 示例代码 Sample code
<!-- 如果你有解决方案,在这里清晰地阐述。 -->
<!-- If you have a solution, state it clearly here. -->
### 🚑 其他信息 Other information
<!-- 如截图等其他信息可以贴在这里。 -->
<!-- Other information such as screenshots can be posted here. -->
<!-- From: https://github.com/one-template/issue-template -->

19
.github/ISSUE_TEMPLATE/resource.md vendored Normal file
View File

@@ -0,0 +1,19 @@
---
name: '💎 资源参考'
about: Reference resources
title: '[Resource] some'
labels: 'resource'
assignees: ''
---
### 😎 资源类别 Resource category
<!-- 描述你所提供资源的类别。 -->
<!-- Describe the type of resource you provide. -->
### 🎨 资源内容 Resource content
<!-- 列出你所提供资源的详细内容。 -->
<!-- List the details of the resources you provide. -->
<!-- From: https://github.com/one-template/issue-template -->

55
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@@ -0,0 +1,55 @@
<!--
首先,感谢你的贡献!😄
First of all, thank you for your contribution! 😄
-->
### 🤔 这个变动的性质是?/ What is the nature of this change?
- [ ] 新特性提交 / New feature
- [ ] bug 修复 / Fix bug
- [ ] 样式优化 / Style optimization
- [ ] 包体积优化 / Package size optimization
- [ ] 性能优化 / Performance optimization
- [ ] 代码风格优化 / Code style optimization
- [ ] 构建优化 / Build optimization
- [ ] 网站、文档、Demo 改进 / Website, documentation, demo improvements
- [ ] 测试相关 / Test related
- [ ] 其他 / Other
### 🔗 相关 Issue / Related Issue
<!--
描述相关需求的来源,如相关的 issue 讨论链接。
Describe the source of related requirements, such as the related issue discussion link.
-->
### 💡 需求背景和解决方案 / Background or solution
<!--
解决的具体问题。
The specific problem solved.
-->
### 📝 更新日志 / Changelog
<!--
从用户角度描述具体变化,以及可能的 breaking change 和其他风险。
Describe changes from the user side, and list all potential break changes or other risks.
--->
| Language | Changelog |
| ---------- | --------- |
| 🇺🇸 English | |
| 🇨🇳 Chinese | |
### ☑️ 请求合并前的自查清单 / Self Check before Merge
⚠️ 请自检并全部**勾选全部选项**。/ Please check all items below before review. ⚠️
- [ ] 文档已补充或无须补充 / Doc is updated/provided or not needed
- [ ] 代码演示已提供或无须提供 / Demo is updated/provided or not needed
- [ ] TypeScript 定义已补充或无须补充 / TypeScript definition is updated/provided or not needed
- [ ] Changelog 已提供或无须提供 / Changelog is provided or not needed
<!-- From: https://github.com/one-template/pr-template -->