Skip to content

Commit 77420df

Browse files
authored
chore: update pull requests and issues template (#2584)
1 parent 3c114d1 commit 77420df

File tree

5 files changed

+106
-116
lines changed

5 files changed

+106
-116
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 54 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Bug Report
2+
description: Submit a bug report.
3+
labels: ['bug', 'Triage']
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report! **Please write in English**.
10+
Before creating an issue please make sure you are using the latest version of Docsify.
11+
12+
- type: textarea
13+
attributes:
14+
label: Description
15+
description: A clear and concise description of what the bug is, and why you consider it to be a bug.
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
attributes:
21+
label: Expected behavior
22+
description: A description of what you expected to happen.
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: Actual behavior
28+
description: A description of what is actually happening.
29+
validations:
30+
required: true
31+
- type: textarea
32+
attributes:
33+
label: Steps to reproduce
34+
description: |
35+
A description with steps to reproduce the issue.
36+
Provide a link to a public repository or create a reproducible [sandbox](https://codesandbox.io/s/307qqv236):
37+
placeholder: |
38+
1. Step 1
39+
2. Step 2
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
attributes:
45+
label: Environment
46+
description: |
47+
Please provide the following information if relevant to the issue:
48+
```markdown
49+
- Your OS:
50+
- Node.js version:
51+
- npm/yarn version:
52+
- Browser version:
53+
- Docsify version:
54+
- Docsify plugins (if the bug happens when plugins enabled, please try to isolate the issue):
55+
```
56+
57+
- type: checkboxes
58+
attributes:
59+
label: Additional Information
60+
options:
61+
- label: Bug still occurs when all/other plugins are disabled?

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 32 deletions
This file was deleted.
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Feature Request
2+
description: Propose a new feature or improvement for this project.
3+
labels: ['feature request', 'Triage']
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for suggesting a feature! Please provide as much detail as possible to help us understand your idea. **Write in English.**
10+
11+
- type: textarea
12+
attributes:
13+
label: Problem or Desire
14+
description: What problem or need will this feature address? Why is it important?
15+
validations:
16+
required: true
17+
18+
- type: textarea
19+
attributes:
20+
label: Proposal
21+
description: What is your proposed solution? How should this feature work?
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
attributes:
27+
label: Implementation Details
28+
description: If you have any ideas about how this feature could be implemented, please share them here.
29+
30+
- type: textarea
31+
attributes:
32+
label: Additional Context
33+
description: Add any other context, screenshots, or references that might help us understand your request.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 12 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,35 @@
1-
<!--
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.
5-
-->
6-
71
## Summary
82

9-
<!--
10-
Describe what the change does and why it should be merged.
11-
Provide **before/after** screenshots for any UI changes.
12-
-->
3+
<!-- Describe what the change does and why it should be merged. Provide **before/after** screenshots for any UI changes. -->
134

145
## Related issue, if any:
156

167
<!-- Paste issue's link or number hashtag here. -->
178

189
## What kind of change does this PR introduce?
1910

20-
<!--
21-
Copy/paste any of the relevant following options:
22-
23-
Bugfix
24-
Feature
25-
Code style update
26-
Refactor
27-
Docs
28-
Build-related changes
29-
Repo settings
30-
Other
11+
<!-- (Change "[ ]" to "[x]" to check a box.) -->
3112

32-
If you choose Other, describe it.
33-
-->
13+
- [ ] Bugfix
14+
- [ ] Feature
15+
- [ ] Code style update (formatting, renaming)
16+
- [ ] Refactoring (no functional changes, no api changes)
17+
- [ ] Build related changes
18+
- [ ] Documentation content changes
19+
- [ ] Other (please describe):
3420

3521
## For any code change,
3622

37-
<!-- (Change "[ ]" to "[x]" to check a box.) -->
38-
3923
- [ ] Related documentation has been updated, if needed
4024
- [ ] Related tests have been added or updated, if needed
4125

4226
## Does this PR introduce a breaking change?
4327

44-
<!-- (pick one) -->
45-
46-
Yes
47-
No
48-
4928
<!-- If yes, describe the impact and migration path for existing applications. -->
5029

30+
- [ ] Yes
31+
- [ ] No
32+
5133
## Tested in the following browsers:
5234

5335
- [ ] Chrome

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy