Skip to content

Commit 407f6ed

Browse files
committed
update: github template
1 parent 3f51c5e commit 407f6ed

File tree

4 files changed

+69
-0
lines changed

4 files changed

+69
-0
lines changed

.github/ISSUE_TEMPLATE/Bug_report.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,31 @@ about: 报告错误
44

55
---
66

7+
<!-- English Version -->
8+
9+
## Actual Description
10+
11+
- File Path: for example, `book/en-us/02-usability.md`
12+
- Original paragraph:
13+
14+
```
15+
A copy of the original paragraph
16+
```
17+
18+
## Expected Description
19+
20+
```
21+
A modified paragraph
22+
```
23+
24+
## Attachments
25+
26+
Attach screenshot or files if necessary.
27+
28+
---
29+
30+
<!-- 中文版本 -->
31+
732
## 实际描述
833

934
- 文件路径:例如,book/zh-cn/02-usability.md

.github/ISSUE_TEMPLATE/Feature_request.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,20 @@ about: 内容建议
44

55
---
66

7+
<!-- English Version -->
8+
9+
## Motivation
10+
11+
Please briefly describe your motivation.
12+
13+
## Requirements
14+
15+
Please list all of your suggestions.
16+
17+
---
18+
19+
<!-- 中文版 -->
20+
721
## 动机
822

923
请描述你提交内容建议的动机。

.github/ISSUE_TEMPLATE/Question.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@ about: 提交问题
44

55
---
66

7+
<!-- English Version -->
8+
9+
## Question
10+
11+
Please describe your question here, and read [How-To-Ask-Questions-The-Smart-Way](http://www.catb.org/~esr/faqs/smart-questions.html) before you submit your question.
12+
13+
---
14+
15+
<!-- 中文版 -->
16+
717
## 问题描述
818

919
请在此描述你的问题,提问前请参考[提问的智慧](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/master/README-zh_CN.md)

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,25 @@
11
resolve #issue_id
22

3+
<!-- English Version -->
4+
5+
## Description
6+
7+
Please describe the motivation of this pull request, and what problem was solved in this PR.
8+
9+
## Change List
10+
11+
- Fix typo error of XXX
12+
- Add description regarding XXX feature
13+
- Resolve error content of XXX
14+
15+
## Reference
16+
17+
Please add reference if necessary
18+
19+
---
20+
21+
<!-- 中文版 -->
22+
323
## 说明
424

525
此处详细说明 PR 的动机是什么、解决了什么样的问题。

0 commit comments

Comments
 (0)