mirror of
https://github.com/zhigang1992/docz.git
synced 2026-05-30 14:15:56 +08:00
chore: add issue and pull request templates (#13)
This commit is contained in:
committed by
Pedro Nauck
parent
c6d6f5134e
commit
c550a265a4
36
.github/ISSUE_TEMPLATE/---bug-report.md
vendored
Normal file
36
.github/ISSUE_TEMPLATE/---bug-report.md
vendored
Normal file
@@ -0,0 +1,36 @@
|
||||
---
|
||||
name: "\U0001F41B Bug report"
|
||||
about: "Something is broken? \U0001F528"
|
||||
|
||||
---
|
||||
|
||||
## Bug Report
|
||||
|
||||
**Describe the bug**
|
||||
|
||||
*A clear and concise description of what the bug is.*
|
||||
|
||||
**To Reproduce**
|
||||
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
|
||||
```shell
|
||||
FOR BUGS: Insert debug trace
|
||||
```
|
||||
|
||||
*In order to allow us to quickly reproduce you issue please include a link to a reproduction repository.*
|
||||
|
||||
**Expected behavior**
|
||||
|
||||
*A clear and concise description of what you expected to happen..*
|
||||
|
||||
**Enviroment**
|
||||
|
||||
* OS: [e.g. OSX 10.13.4, Windows 10]
|
||||
* Node/npm version: [e.g. Node 8/npm 5]
|
||||
|
||||
**Additional context/Screenshots**
|
||||
Add any other context about the problem here. If applicable, add screenshots to help explain.
|
||||
20
.github/ISSUE_TEMPLATE/---feature-request.md
vendored
Normal file
20
.github/ISSUE_TEMPLATE/---feature-request.md
vendored
Normal file
@@ -0,0 +1,20 @@
|
||||
---
|
||||
name: "\U0001F680 Feature Request"
|
||||
about: "I have a suggestion (and may want to implement it \U0001F642)!"
|
||||
|
||||
---
|
||||
|
||||
## Feature Request
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I have an issue when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen. Add any considered drawbacks.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Teachability, Documentation, Adoption, Migration Strategy**
|
||||
If you can, explain how users will be able to use this and possibly write out a version the docs.
|
||||
Maybe a screenshot or design?
|
||||
12
.github/ISSUE_TEMPLATE/---support-question.md
vendored
Normal file
12
.github/ISSUE_TEMPLATE/---support-question.md
vendored
Normal file
@@ -0,0 +1,12 @@
|
||||
---
|
||||
name: "\U0001F917 Support Question"
|
||||
about: "I have a question \U0001F4AC"
|
||||
|
||||
---
|
||||
|
||||
## Question
|
||||
|
||||
**Description**
|
||||
*Give more information about your doubt*
|
||||
|
||||
* Twitter: If it's just a quick question you can ping me on Twitter: https://twitter.com/pedronauck
|
||||
20
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
20
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,20 @@
|
||||
### Description
|
||||
|
||||
Add here a description about your Pull Request
|
||||
|
||||
### Review
|
||||
|
||||
- [ ] Check the copy
|
||||
- [ ] ...
|
||||
- [ ] ...
|
||||
|
||||
### Pre-merge checklist
|
||||
|
||||
- [ ] ...
|
||||
- [ ] ...
|
||||
|
||||
### Screenshots
|
||||
|
||||
| Before | After |
|
||||
| ------ | ----- |
|
||||
| Image | Image |
|
||||
Reference in New Issue
Block a user