Skip to content

chore: update pull requests and issues template #2584

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 30, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 0 additions & 54 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -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?
32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -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.
42 changes: 12 additions & 30 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,35 @@
<!--
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:

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

## What kind of change does this PR introduce?

<!--
Copy/paste any of the relevant following options:

Bugfix
Feature
Code style update
Refactor
Docs
Build-related changes
Repo settings
Other
<!-- (Change "[ ]" to "[x]" to check a box.) -->

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
Expand Down
Loading