diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 81a77b7e3..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -name: Bug report -about: Create a report to help us fix an issue ---- - - - -## Bug Report - -#### Steps to reproduce - - - -#### Current behaviour - - - -#### Expected behaviour - - - -#### Other relevant information - -- Docsify version: - - - -- [ ] 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 create a reproducible sandbox - -[![Edit 307qqv236](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/307qqv236) - -#### Mention the docsify version in which this bug was not present (if any) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..5326336cc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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? diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index cb840f656..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project ---- - - - -## Feature request - -#### Problem or desire - - - -#### Proposal - - - -#### Implementation - - diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..50adeb402 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9e1aea115..e03dcea0c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,15 +1,6 @@ - - ## Summary - + ## Related issue, if any: @@ -17,37 +8,28 @@ Provide **before/after** screenshots for any UI changes. ## What kind of change does this PR introduce? - - 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, - - - [ ] Related documentation has been updated, if needed - [ ] Related tests have been added or updated, if needed ## Does this PR introduce a breaking change? - - -Yes -No - +- [ ] Yes +- [ ] No + ## Tested in the following browsers: - [ ] Chrome