Skip to content

Commit 29b20e3

Browse files
authored
docs: add template & issue action (#305)
* docs: add pr template * Create bug_report.md * Create question.md * Create issue-reply.yml
1 parent 231caea commit 29b20e3

4 files changed

Lines changed: 122 additions & 0 deletions

File tree

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: 🐛 Report Bug
3+
about: Report Bug.
4+
title: '[BUG] Report bug'
5+
labels: 'bug'
6+
assignees:
7+
---
8+
9+
### 🐛 Bug description
10+
11+
12+
<!-- Please describe the bug in detail above so that everyone can understand. -->
13+
14+
### 🏞 Desired result
15+
16+
17+
<!-- Please describe above what you expected to see. -->
18+
19+
### 🚑 Other information
20+
21+
22+
<!-- Please enter other information such as screenshots above. -->
23+
<!-- From: https://github.com/one-template/issue-template -->

.github/ISSUE_TEMPLATE/question.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: '❓ Question or need help'
3+
about: Question or need help
4+
title: '[Question] Help'
5+
labels: 'question'
6+
assignees: ''
7+
---
8+
9+
### 🧐 Problem Description
10+
11+
12+
<!-- Describe the problem in detail so that everyone can understand. -->
13+
14+
### 💻 Sample code
15+
16+
17+
<!-- If you have a solution, state it clearly here. -->
18+
19+
### 🚑 Other information
20+
21+
22+
<!-- Other information such as screenshots can be posted here. -->
23+
<!-- From: https://github.com/one-template/issue-template -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<!--
2+
First of all, thank you for your contribution! 😄
3+
-->
4+
5+
### 🤔 What is the nature of this change?
6+
7+
- [ ] New feature
8+
- [ ] Fix bug
9+
- [ ] Style optimization
10+
- [ ] Code style optimization
11+
- [ ] Performance optimization
12+
- [ ] Build optimization
13+
- [ ] Refactor code or style
14+
- [ ] Test related
15+
- [ ] Other
16+
17+
### 🔗 Related Issue
18+
19+
<!--
20+
Describe the source of related requirements, such as the related issue discussion link.
21+
-->
22+
23+
### 💡 Background or solution
24+
25+
<!--
26+
The specific problem solved.
27+
-->
28+
29+
### 📝 Changelog
30+
31+
<!--
32+
Describe changes from the user side, and list all potential break changes or other risks.
33+
--->
34+
35+
| Language | Changelog |
36+
| ---------- | --------- |
37+
| 🇺🇸 English | |
38+
| 🇨🇳 Chinese | |
39+
40+
### ☑️ Self Check before Merge
41+
42+
⚠️ Please check all items below before review. ⚠️
43+
44+
- [ ] Doc is updated/provided or not needed
45+
- [ ] Demo is updated/provided or not needed
46+
- [ ] TypeScript definition is updated/provided or not needed
47+
- [ ] Changelog is provided or not needed
48+
49+
<!-- From: https://github.com/one-template/pr-template -->

.github/workflows/issue-reply.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Issue Reply
2+
3+
on:
4+
issues:
5+
types: [labeled]
6+
7+
jobs:
8+
reply-helper:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: help wanted
12+
if: github.event.label.name == 'help wanted'
13+
uses: actions-cool/issues-helper@v2.1.1
14+
with:
15+
actions: 'create-comment'
16+
issue-number: ${{ github.event.issue.number }}
17+
body: |
18+
Hello @${{ github.event.issue.user.login }}. We totally like your proposal/feedback, welcome to send us a Pull Request for it. Please be sure to fill in the default template in the Pull Request, provide changelog/documentation/test cases if needed and make sure CI passed, we will review it soon. We appreciate your effort in advance and looking forward to your contribution!
19+
20+
- name: need reproduction
21+
if: github.event.label.name == 'need reproduction'
22+
uses: actions-cool/issues-helper@v2.1.1
23+
with:
24+
actions: 'create-comment'
25+
issue-number: ${{ github.event.issue.number }}
26+
body: |
27+
Hello @${{ github.event.issue.user.login }}. In order to facilitate location and troubleshooting, we need you to provide a realistic example. Please forking these link [codesandbox](https://codesandbox.io/) or provide your GitHub repository.

0 commit comments

Comments
 (0)