Skip to content

Commit 09616de

Browse files
committed
Update GitHub templates
1 parent f74b53f commit 09616de

4 files changed

Lines changed: 114 additions & 5 deletions

File tree

.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 2 deletions
This file was deleted.
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
5+
---
6+
<!-- Please don't delete this template or we'll close your issue -->
7+
<!-- Please use English language -->
8+
<!-- Before creating an issue please make sure you are using the latest version of Docsify. -->
9+
<!-- Please ask questions on StackOverflow: https://stackoverflow.com/questions/ask?tags=docsify -->
10+
11+
## Bug Report
12+
13+
#### Steps to reproduce
14+
15+
16+
17+
#### What is current behaviour
18+
19+
20+
21+
#### What is the expected behaviour
22+
23+
---
24+
25+
- [ ] Bug does still occur when all/other plugins are disabled?
26+
27+
<!-- Please type in your environment -->
28+
Environment:
29+
30+
```
31+
docsify version:
32+
docsify plugins:
33+
browser:
34+
```
35+
36+
<!-- Love docsify? Please consider supporting our collective:
37+
👉 https://opencollective.com/docsify/donate -->
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
5+
---
6+
<!-- Please don't delete this template or we'll close your issue -->
7+
<!-- Please use English language -->
8+
<!-- Before creating an issue please make sure you are using the latest version of Docsify. -->
9+
<!-- Please ask questions on StackOverflow 👉 https://stackoverflow.com/questions/ask?tags=docsify -->
10+
11+
## Feature request
12+
13+
#### What problem does this feature solve?
14+
15+
16+
17+
#### What does the proposed API look like?
18+
19+
20+
21+
#### How should this be implemented in your opinion?
22+
23+
24+
25+
#### Are you willing to work on this yourself?

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 52 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,54 @@
1-
Please makes sure these boxes are checked before submitting your PR, thank you!
1+
<!-- Please use English language -->
2+
<!-- Please don't delete this template -->
3+
4+
<!-- PULL REQUEST TEMPLATE -->
5+
<!-- (Update "[ ]" to "[x]" to check a box) -->
6+
7+
**Summary**
8+
9+
**What kind of change does this PR introduce?** (check at least one)
10+
11+
- [ ] Bugfix
12+
- [ ] Feature
13+
- [ ] Code style update
14+
- [ ] Refactor
15+
- [ ] Docs
16+
- [ ] Build-related changes
17+
- [ ] Other, please describe:
18+
19+
If changing the UI of default theme, please provide the **before/after** screenshot:
20+
21+
**Does this PR introduce a breaking change?** (check one)
22+
23+
- [ ] Yes
24+
- [ ] No
25+
26+
If yes, please describe the impact and migration path for existing applications:
27+
28+
**The PR fulfills these requirements:**
29+
30+
- [ ] When resolving a specific issue, it's referenced in the PR's title (e.g. `fix #xxx[,#xxx]`, where "xxx" is the issue number)
31+
32+
You have tested in the following browsers: (Providing a detailed version will be better.)
33+
34+
- [ ] Chrome
35+
- [ ] Firefox
36+
- [ ] Safari
37+
- [ ] Edge
38+
- [ ] IE
39+
40+
If adding a **new feature**, the PR's description includes:
41+
42+
- [ ] A convincing reason for adding this feature
43+
- [ ] Related documents have been updated
44+
- [ ] Related tests have been updated
45+
46+
To avoid wasting your time, it's best to open a **feature request issue** first and wait for approval before working on it.
47+
48+
49+
**Other information:**
50+
51+
---
252

3-
* [ ] Make sure you are merging your commits to `master` branch.
4-
* [ ] Add some descriptions and refer relative issues for you PR.
553
* [ ] DO NOT include files inside `lib` directory.
54+

0 commit comments

Comments
 (0)