docs: add template & issue action (#305)

* docs: add pr template

* Create bug_report.md

* Create question.md

* Create issue-reply.yml
This commit is contained in:
xrkffgg 2021-02-07 10:37:12 +08:00 committed by GitHub
parent 231caea783
commit 29b20e3eb5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 122 additions and 0 deletions

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

@ -0,0 +1,23 @@
---
name: 🐛 Report Bug
about: Report Bug.
title: '[BUG] Report bug'
labels: 'bug'
assignees:
---
### 🐛 Bug description
<!-- 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 -->

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

@ -0,0 +1,23 @@
---
name: '❓ Question or need help'
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 -->

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

@ -0,0 +1,49 @@
<!--
First of all, thank you for your contribution! 😄
-->
### 🤔 What is the nature of this change?
- [ ] New feature
- [ ] Fix bug
- [ ] Style optimization
- [ ] Code style optimization
- [ ] Performance optimization
- [ ] Build optimization
- [ ] Refactor code or style
- [ ] Test related
- [ ] Other
### 🔗 Related Issue
<!--
Describe the source of related requirements, such as the related issue discussion link.
-->
### 💡 Background or solution
<!--
The specific problem solved.
-->
### 📝 Changelog
<!--
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 definition is updated/provided or not needed
- [ ] Changelog is provided or not needed
<!-- From: https://github.com/one-template/pr-template -->

27
.github/workflows/issue-reply.yml vendored Normal file
View File

@ -0,0 +1,27 @@
name: Issue Reply
on:
issues:
types: [labeled]
jobs:
reply-helper:
runs-on: ubuntu-latest
steps:
- name: help wanted
if: github.event.label.name == 'help wanted'
uses: actions-cool/issues-helper@v2.1.1
with:
actions: 'create-comment'
issue-number: ${{ github.event.issue.number }}
body: |
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!
- name: need reproduction
if: github.event.label.name == 'need reproduction'
uses: actions-cool/issues-helper@v2.1.1
with:
actions: 'create-comment'
issue-number: ${{ github.event.issue.number }}
body: |
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.