diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 353fae2aca..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -name: Bug report -about: Something isn't working as expected -title: '' -labels: '' -assignees: '' - ---- - - - -## Check List - -Please check followings before submitting a new issue. - -- [ ] I have already read [Docs page](https://hexo.io/docs/) & [Troubleshooting page](https://hexo.io/docs/troubleshooting) -- [ ] I have already searched existing issues and they are not help to me -- [ ] I examined error or warning messages and it's difficult to solve -- [ ] Using [the latest](https://github.com/hexojs/hexo/releases) version of Hexo (run `hexo version` to check) -- [ ] Node.js is higher than [minimum required version](https://hexo.io/docs/#Minimum-required-Node-js-version) - -## Expected behavior - -## Actual behavior - -## How to reproduce? - -* Step1 -* Step2 -* etc... - -## Is the problem still there under "Safe mode"? - - - -## Environment & Settings - -**Node.js & npm version(`node -v && npm -v`)** - - - -``` -``` - -**Your site `_config.yml`** (Optional) - - - -```yaml -``` - -**Hexo and Plugin version(`npm ls --depth 0`)** - - - -``` -``` - -**Your package.json `package.json`** - - - -``` -``` - -## Others - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000..4c1e219d45 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,148 @@ +name: Bug report +description: Something isn't working as expected. +# title: "" +# labels: [] +# assignees: [] + +body: + - type: markdown + attributes: + value: | + ## Tips + + - 给简体中文用户的提示: + + - 在提交 issue 时请按照下面的模板提供相关信息，这将有助于我们发现问题。 + - 请尽量使用英语描述你遇到的问题，这可以让更多的人帮助到你。 + + - A good bug report should have your configuration and build environment information, which are essential for us to investigate the problem. We've provided the following steps on how to attach the necessary information. + + - If you find that markdown files are not rendered as expected, please go to https://marked.js.org/demo/ to see if it can be reproduced there. If it can be reproduced, please file a bug to https://github.com/markedjs/marked. + + - If you want help on your bug, please also send us the git repository (GitHub, GitLab, Bitbucket, etc.) where your hexo code is stored. It would greatly help. If you prefer not to have your hexo code out in public, please upload to a private GitHub repository and grant read-only access to `hexojs/core`. + + - Please take extra precaution not to attach any secret or personal information. (likes personal privacy, password, GitHub Personal Access Token, etc.) + + ------ + + - type: checkboxes + validations: + required: true + attributes: + label: Check List + description: Please check followings before submitting a new issue. + options: + - label: I have already read [Docs page](https://hexo.io/docs/) & [Troubleshooting page](https://hexo.io/docs/troubleshooting). + - label: I have already searched existing issues and they are not help to me. + - label: I examined error or warning messages and it's difficult to solve. + - label: I am using the [latest](https://github.com/hexojs/hexo/releases) version of Hexo. (run `hexo version` to check) + - label: My Node.js is matched [the required version](https://hexo.io/docs/#Required-Node-js-version). + + - type: textarea + validations: + required: true + attributes: + label: Expected behavior + # description: + placeholder: Descripe what you expected to happen. + # value: + # render: + + - type: textarea + validations: + required: true + attributes: + label: Actual behavior + # description: + placeholder: Descripe what actually happen. + # value: + # render: + + - type: textarea + validations: + required: true + attributes: + label: How to reproduce? + description: How do you trigger this bug? Please walk us through it step by step. + placeholder: | + 1. Step1 + 2. Step2 + 3. etc. + ... + # value: + # render: + + - type: input + validations: + required: true + attributes: + label: Is the problem still there under `Safe mode`? + description: | + https://hexo.io/docs/commands#Safe-mode + + "Safe mode" will disable all the plugins and scripts. + If your problem disappear under "Safe mode" means the problem is probably at your newly installed plugins, not at hexo. + # placeholder: + # value: | + # render: + + - type: markdown + attributes: + value: | + ------ + + ## Environment & Settings + + - type: textarea + validations: + required: false + attributes: + label: Your Node.js & npm version + description: | + Please run `node -v && npm -v` + and paste the output here. + placeholder: node -v && npm -v + # value: | + render: text + + - type: textarea + validations: + required: false + attributes: + label: Your Hexo and Plugin version + description: | + Please run `npm ls --depth 0` + and paste the output here. + placeholder: npm ls --depth 0 + # value: + render: text + + - type: textarea + validations: + required: false + attributes: + label: Your `package.json` + description: Please paste the content of `package.json` here. + placeholder: package.json + # value: + render: json + + - type: textarea + validations: + required: false + attributes: + label: Your site's `_config.yml` (Optional) + description: Please paste the content of your `_config.yml` here. + placeholder: _config.yml + # value: | + render: yaml + + - type: textarea + validations: + required: false + attributes: + label: Others + description: If you have other information. Please write here. + # placeholder: + # value: + # render: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 3c6bdca6bd..5548b4bc8c 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -2,4 +2,4 @@ blank_issues_enabled: false contact_links: - name: Ask a Question, Help, Discuss url: https://github.com/hexojs/hexo/discussions - about: I have a question, help for hexo (e.g. Customize) \ No newline at end of file + about: I have a question, help for hexo (e.g. Customize) diff --git a/.github/ISSUE_TEMPLATE/feature-request-improvement.md b/.github/ISSUE_TEMPLATE/feature-request-improvement.md deleted file mode 100644 index 46f8ad6691..0000000000 --- a/.github/ISSUE_TEMPLATE/feature-request-improvement.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: Feature request / Improvement -about: I have a feature request, suggestion, improvement etc... -title: '' -labels: '' -assignees: '' - ---- - -## Check List - -Please check followings before submitting a new feature request. - -- [ ] I have already read [Docs page](https://hexo.io/docs/) -- [ ] I have already searched existing issues - -## Feature Request - - - -## Others - - diff --git a/.github/ISSUE_TEMPLATE/feature-request-improvement.yml b/.github/ISSUE_TEMPLATE/feature-request-improvement.yml new file mode 100644 index 0000000000..32db67e4e2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request-improvement.yml @@ -0,0 +1,36 @@ +name: Feature request / Improvement +description: I have a feature request, suggestion, improvement etc... +# title: "" +# labels: [] +# assignees: [] + +body: + - type: checkboxes + validations: + required: true + attributes: + label: Check List + description: Please check followings before submitting a new feature request. + options: + - label: I have already read [Docs page](https://hexo.io/docs/). + - label: I have already searched existing issues. + + - type: textarea + validations: + required: true + attributes: + label: Feature Request + description: Descripe the feature and why it is needed. + # placeholder: + # value: + # render: + + - type: textarea + validations: + required: false + attributes: + label: Others + description: If you have other information. Please write here. + # placeholder: + # value: + # render: