Skip to content

Commit 5591849

Browse files
trusktrtrusktr
committed
chore: update issue/pr templates
1 parent 7c32ad8 commit 5591849

File tree

4 files changed

+73
-65
lines changed

4 files changed

+73
-65
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+30-21
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,53 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
4-
3+
about: Create a report to help us fix an issue
54
---
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-
<!-- Please ask questions on Discord: https://discord.gg/3NwKFyR -->
5+
6+
<!--
7+
Please don't delete this template or we'll close your issue.
8+
Please write in English.
9+
Before creating an issue please make sure you are using the latest version of Docsify.
10+
Please ask questions on StackOverflow (👉 https://stackoverflow.com/questions/ask?tags=docsify)
11+
or in our Discord chat server (👉 https://discord.gg/docsify).
12+
-->
1113

1214
## Bug Report
1315

1416
#### Steps to reproduce
1517

18+
<!-- List the steps needed to reproduce here. -->
19+
20+
#### Current behaviour
1621

22+
<!-- Describe the current behavior here. -->
1723

18-
#### What is current behaviour
24+
#### Expected behaviour
1925

26+
<!-- Describe the expected behavior here. -->
2027

28+
#### Other relevant information
2129

22-
#### What is the expected behaviour
30+
- Docsify version:
2331

32+
<!-- (Change "[ ]" to "[x]" to check a box.) -->
2433

34+
- [ ] Bug still occurs when all/other plugins are disabled?
2535

26-
#### Other relevant information
36+
- Docsify plugins (if the bug happens when plugins enabled, please try to isolate the issue):
37+
38+
<!-- Please provide the following information if relevant to the issue.
2739
28-
<!-- (Update "[ ]" to "[x]" to check a box) -->
29-
- [ ] Bug does still occur when all/other plugins are disabled?
40+
- Your OS:
41+
- Node.js version:
42+
- npm/yarn version:
43+
- Browser version:
3044
31-
- Your OS:
32-
- Node.js version:
33-
- npm/yarn version:
34-
- Browser version:
35-
- Docsify version:
36-
- Docsify plugins:
45+
-->
3746

38-
<!-- Love docsify? Please consider supporting our collective:
39-
👉 https://opencollective.com/docsify/donate -->
47+
<!-- Love docsify and want to help us advance Docsify or to spend time supporting your case? Please consider supporting our collective:
48+
👉 https://opencollective.com/docsify/donate -->
4049

41-
#### Please create a reproducible sandbox
50+
#### Please create a reproducible sandbox
4251

4352
[![Edit 307qqv236](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/307qqv236)
4453

‎.github/ISSUE_TEMPLATE/config.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
blank_issues_enabled: false
22
contact_links:
33
- name: Discord - the community chat
4-
url: https://discord.gg/3NwKFyR
5-
about: Join Discord community and chat about Docsify
4+
url: https://discord.gg/docsify
5+
about: Join the Discord community and chat about Docsify

‎.github/ISSUE_TEMPLATE/feature_request.md

+19-12
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,32 @@
11
---
22
name: Feature request
33
about: Suggest an idea for this project
4-
54
---
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?
145

6+
<!--
7+
Please don't delete this template or we'll close your issue.
8+
Please write in English.
9+
Before creating an issue please make sure you are using the latest version of Docsify.
10+
Please ask questions on StackOverflow (👉 https://stackoverflow.com/questions/ask?tags=docsify)
11+
or in our Discord chat server (👉 https://discord.gg/docsify).
12+
-->
1513

14+
## Feature request
1615

17-
#### What does the proposed API look like?
16+
#### Problem or desire
1817

18+
<!-- Describe what problem this feature will solve. -->
1919

20+
#### Proposal
2021

21-
#### How should this be implemented in your opinion?
22+
<!-- What does the proposed feature look like? -->
2223

24+
#### Implementation
2325

26+
<!--
27+
How should the feature be implemented in your opinion?
2428
25-
#### Are you willing to work on this yourself?
29+
We have limited free time. Please consider contributing, or donating to our
30+
OpenCollective (👉 https://opencollective.com/docsify/donate), to help get this
31+
feature added and to advance Docsify.
32+
-->

‎.github/PULL_REQUEST_TEMPLATE.md

+22-30
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,25 @@
11
<!--
2-
PULL REQUEST TEMPLATE
3-
---
4-
Please use English language
5-
Please don't delete this template
6-
---
7-
Update "[ ]" to "[x]" to check a box in any list below.
8-
---
9-
To avoid wasting your time, it's best to open a **feature request issue** first and wait for approval before working on it.
2+
Please write in English.
3+
Please follow the template, all sections are required.
4+
Consider opening a feature request first to get your change idea approved.
105
-->
116

12-
## **Summary**
7+
## Summary
138

149
<!--
15-
THIS IS REQUIRED! Please describe what the change does and why it should be merged.
10+
Describe what the change does and why it should be merged.
11+
Provide **before/after** screenshots for any UI changes.
1612
-->
1713

18-
<!--
19-
If changing the UI in any way, please provide the a **before/after** screenshot:
20-
-->
14+
## Related issue, if any:
2115

22-
## **What kind of change does this PR introduce?**
16+
<!-- Paste issue's link or number hashtag here. -->
2317

24-
<!--
25-
Copy/paste one of the following options:
26-
-->
18+
## What kind of change does this PR introduce?
2719

2820
<!--
21+
Copy/paste any of the relevant following options:
22+
2923
Bugfix
3024
Feature
3125
Code style update
@@ -34,29 +28,27 @@
3428
Build-related changes
3529
Repo settings
3630
Other
37-
-->
3831
39-
<!--
40-
If you chose Other, please describe.
32+
If you choose Other, describe it.
4133
-->
4234

43-
## **For any code change,**
35+
## For any code change,
4436

45-
- [ ] Related documentation has been updated if needed
46-
- [ ] Related tests have been updated or tests have been added
37+
<!-- (Change "[ ]" to "[x]" to check a box.) -->
4738

48-
## **Does this PR introduce a breaking change?** (check one)
39+
- [ ] Related documentation has been updated, if needed
40+
- [ ] Related tests have been added or updated, if needed
4941

50-
- [ ] Yes
51-
- [ ] No
42+
## Does this PR introduce a breaking change?
5243

53-
If yes, please describe the impact and migration path for existing applications:
44+
<!-- (pick one) -->
5445

55-
## **Related issue, if any:**
46+
Yes
47+
No
5648

57-
<!-- Paste issue's link or number hashtag here. -->
49+
<!-- If yes, describe the impact and migration path for existing applications. -->
5850

59-
## **Tested in the following browsers:**
51+
## Tested in the following browsers:
6052

6153
- [ ] Chrome
6254
- [ ] Firefox

0 commit comments

Comments
 (0)