mirror of
https://github.com/docsifyjs/docsify.git
synced 2026-10-16 20:21:38 +08:00
chore: update pull requests and issues template (#2584)
This commit is contained in:
Luffy
@@ -1,54 +0,0 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us fix an issue
|
||||
---
|
||||
|
||||
<!--
|
||||
Please don't delete this template or we'll close your issue.
|
||||
Please write in English.
|
||||
Before creating an issue please make sure you are using the latest version of Docsify.
|
||||
Please ask questions on StackOverflow (👉 https://stackoverflow.com/questions/ask?tags=docsify)
|
||||
or in our Discord chat server (👉 https://discord.gg/docsify).
|
||||
-->
|
||||
|
||||
## Bug Report
|
||||
|
||||
#### Steps to reproduce
|
||||
|
||||
<!-- List the steps needed to reproduce here. -->
|
||||
|
||||
#### Current behaviour
|
||||
|
||||
<!-- Describe the current behavior here. -->
|
||||
|
||||
#### Expected behaviour
|
||||
|
||||
<!-- Describe the expected behavior here. -->
|
||||
|
||||
#### Other relevant information
|
||||
|
||||
- Docsify version:
|
||||
|
||||
<!-- (Change "[ ]" to "[x]" to check a box.) -->
|
||||
|
||||
- [ ] Bug still occurs when all/other plugins are disabled?
|
||||
|
||||
- Docsify plugins (if the bug happens when plugins enabled, please try to isolate the issue):
|
||||
|
||||
<!-- Please provide the following information if relevant to the issue.
|
||||
|
||||
- Your OS:
|
||||
- Node.js version:
|
||||
- npm/yarn version:
|
||||
- Browser version:
|
||||
|
||||
-->
|
||||
|
||||
<!-- Love docsify and want to help us advance Docsify or to spend time supporting your case? Please consider supporting our collective:
|
||||
👉 https://opencollective.com/docsify/donate -->
|
||||
|
||||
#### Please create a reproducible sandbox
|
||||
|
||||
[](https://codesandbox.io/s/307qqv236)
|
||||
|
||||
#### Mention the docsify version in which this bug was not present (if any)
|
||||
@@ -0,0 +1,61 @@
|
||||
name: Bug Report
|
||||
description: Submit a bug report.
|
||||
labels: ['bug', 'Triage']
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this bug report! **Please write in English**.
|
||||
Before creating an issue please make sure you are using the latest version of Docsify.
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Description
|
||||
description: A clear and concise description of what the bug is, and why you consider it to be a bug.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Expected behavior
|
||||
description: A description of what you expected to happen.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Actual behavior
|
||||
description: A description of what is actually happening.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: |
|
||||
A description with steps to reproduce the issue.
|
||||
Provide a link to a public repository or create a reproducible [sandbox](https://codesandbox.io/s/307qqv236):
|
||||
placeholder: |
|
||||
1. Step 1
|
||||
2. Step 2
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Environment
|
||||
description: |
|
||||
Please provide the following information if relevant to the issue:
|
||||
```markdown
|
||||
- Your OS:
|
||||
- Node.js version:
|
||||
- npm/yarn version:
|
||||
- Browser version:
|
||||
- Docsify version:
|
||||
- Docsify plugins (if the bug happens when plugins enabled, please try to isolate the issue):
|
||||
```
|
||||
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Additional Information
|
||||
options:
|
||||
- label: Bug still occurs when all/other plugins are disabled?
|
||||
@@ -1,32 +0,0 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
---
|
||||
|
||||
<!--
|
||||
Please don't delete this template or we'll close your issue.
|
||||
Please write in English.
|
||||
Before creating an issue please make sure you are using the latest version of Docsify.
|
||||
Please ask questions on StackOverflow (👉 https://stackoverflow.com/questions/ask?tags=docsify)
|
||||
or in our Discord chat server (👉 https://discord.gg/docsify).
|
||||
-->
|
||||
|
||||
## Feature request
|
||||
|
||||
#### Problem or desire
|
||||
|
||||
<!-- Describe what problem this feature will solve. -->
|
||||
|
||||
#### Proposal
|
||||
|
||||
<!-- What does the proposed feature look like? -->
|
||||
|
||||
#### Implementation
|
||||
|
||||
<!--
|
||||
How should the feature be implemented in your opinion?
|
||||
|
||||
We have limited free time. Please consider contributing, or donating to our
|
||||
OpenCollective (👉 https://opencollective.com/docsify/donate), to help get this
|
||||
feature added and to advance Docsify.
|
||||
-->
|
||||
@@ -0,0 +1,33 @@
|
||||
name: Feature Request
|
||||
description: Propose a new feature or improvement for this project.
|
||||
labels: ['feature request', 'Triage']
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thank you for suggesting a feature! Please provide as much detail as possible to help us understand your idea. **Write in English.**
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Problem or Desire
|
||||
description: What problem or need will this feature address? Why is it important?
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Proposal
|
||||
description: What is your proposed solution? How should this feature work?
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Implementation Details
|
||||
description: If you have any ideas about how this feature could be implemented, please share them here.
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Additional Context
|
||||
description: Add any other context, screenshots, or references that might help us understand your request.
|
||||
@@ -1,15 +1,6 @@
|
||||
<!--
|
||||
Please write in English.
|
||||
Please follow the template, all sections are required.
|
||||
Consider opening a feature request first to get your change idea approved.
|
||||
-->
|
||||
|
||||
## Summary
|
||||
|
||||
<!--
|
||||
Describe what the change does and why it should be merged.
|
||||
Provide **before/after** screenshots for any UI changes.
|
||||
-->
|
||||
<!-- Describe what the change does and why it should be merged. Provide **before/after** screenshots for any UI changes. -->
|
||||
|
||||
## Related issue, if any:
|
||||
|
||||
@@ -17,37 +8,28 @@ Provide **before/after** screenshots for any UI changes.
|
||||
|
||||
## What kind of change does this PR introduce?
|
||||
|
||||
<!--
|
||||
Copy/paste any of the relevant following options:
|
||||
<!-- (Change "[ ]" to "[x]" to check a box.) -->
|
||||
|
||||
Bugfix
|
||||
Feature
|
||||
Code style update
|
||||
Refactor
|
||||
Docs
|
||||
Build-related changes
|
||||
Repo settings
|
||||
Other
|
||||
|
||||
If you choose Other, describe it.
|
||||
-->
|
||||
- [ ] Bugfix
|
||||
- [ ] Feature
|
||||
- [ ] Code style update (formatting, renaming)
|
||||
- [ ] Refactoring (no functional changes, no api changes)
|
||||
- [ ] Build related changes
|
||||
- [ ] Documentation content changes
|
||||
- [ ] Other (please describe):
|
||||
|
||||
## For any code change,
|
||||
|
||||
<!-- (Change "[ ]" to "[x]" to check a box.) -->
|
||||
|
||||
- [ ] Related documentation has been updated, if needed
|
||||
- [ ] Related tests have been added or updated, if needed
|
||||
|
||||
## Does this PR introduce a breaking change?
|
||||
|
||||
<!-- (pick one) -->
|
||||
|
||||
Yes
|
||||
No
|
||||
|
||||
<!-- If yes, describe the impact and migration path for existing applications. -->
|
||||
|
||||
- [ ] Yes
|
||||
- [ ] No
|
||||
|
||||
## Tested in the following browsers:
|
||||
|
||||
- [ ] Chrome
|
||||
|
||||
Reference in New Issue
Block a user