diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 830afe8..dd84ea7 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,45 +1,38 @@ --- -name: Bug report 🐞 about: Create a report to help us improve title: '' -labels: bug assignees: '' +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + --- -## Your Environment(您的使用环境) +**Describe the bug** +A clear and concise description of what the bug is. - +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error -* smart-doc version: -* plugin version (e.g. smart-doc-maven-plugin or smart-doc-gradle-plugin): -* build tool version(maven or gradle): +**Expected behavior** +A clear and concise description of what you expected to happen. -## Expected Behavior(您期望的结果) - - - - -## Current Behavior(当前结果) - - - - -## Possible Solution(bug解决建议) - - - - -## Steps to Reproduce (Bug产生步骤,请尽量提供用例代码) - - - - -1. -2. -3. -4. - -## Context(Bug影响描述) - - - +**Screenshots** +If applicable, add screenshots to help explain your problem. +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] +**Additional context** +Add any other context about the problem here.