From bba038ef006d92679881e0935b34546a3a45d76a Mon Sep 17 00:00:00 2001
From: shalousun <smartdoc647@gmail.com>
Date: Fri, 16 Jul 2021 12:42:12 +0800
Subject: [PATCH] update issue templates

---
 .github/ISSUE_TEMPLATE/bug_report.md      | 53 ++++++++++++-----------
 .github/ISSUE_TEMPLATE/feature_request.md | 25 +++++------
 .github/ISSUE_TEMPLATE/issue_template.md  | 45 -------------------
 3 files changed, 38 insertions(+), 85 deletions(-)
 delete mode 100644 .github/ISSUE_TEMPLATE/issue_template.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index dd84ea7..da09d08 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,38 +1,39 @@
 ---
-name: Bug report
+name: Bug report 🐞
 about: Create a report to help us improve
 title: ''
-labels: ''
+labels: bug
 assignees: ''
-
 ---
+## Your Environment(您的使用环境)
+<!--- Include as many relevant details about the environment you experienced the bug in -->
+* smart-doc version:
+* plugin version (e.g. smart-doc-maven-plugin or smart-doc-gradle-plugin):
+* build tool version(maven or gradle):
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+## Expected Behavior(您期望的结果)
+<!--- If you're describing a bug, tell us what should happen -->
+<!--- If you're suggesting a change/improvement, tell us how it should work -->
 
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+## Current Behavior(当前结果)
+<!--- If describing a bug, tell us what happens instead of the expected behavior -->
+<!--- If suggesting a change/improvement, explain the difference from current behavior -->
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+## Possible Solution(bug解决建议)
+<!--- Not obligatory, but suggest a fix/reason for the bug, -->
+<!--- or ideas how to implement the addition or change -->
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+## Steps to Reproduce (Bug产生步骤，请尽量提供用例代码)
+<!--- Provide a link to a live example, or an unambiguous set of steps to -->
+<!--- reproduce this bug. Include code to reproduce, if relevant -->
+1.
+2.
+3.
+4.
+
+## Context(Bug影响描述)
+<!--- How has this issue affected you? What are you trying to accomplish? -->
+<!--- Providing context helps us come up with a solution that is most useful in the real world -->
 
-**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.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index bbcbbe7..1045ec4 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,20 +1,17 @@
 ---
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
+name: Feature Request 💡 
+about: Suggest a new idea for the project. 
+labels: enhancement
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+## Summary(关于这个pr的描述)
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+Brief explanation of the feature.
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+### Basic example(pr的用例)
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+If the proposal involves a new or changed API, include a basic code example. Omit this section if it's not applicable.
+
+### Motivation(提出这个pr目的)
+
+Why are we doing this? What use cases does it support? What is the expected outcome?
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/issue_template.md b/.github/ISSUE_TEMPLATE/issue_template.md
deleted file mode 100644
index 830afe8..0000000
--- a/.github/ISSUE_TEMPLATE/issue_template.md
+++ /dev/null
@@ -1,45 +0,0 @@
----
-name: Bug report 🐞 about: Create a report to help us improve title: ''
-labels: bug assignees: ''
----
-
-## Your Environment(您的使用环境)
-
-<!--- Include as many relevant details about the environment you experienced the bug in -->
-
-* smart-doc version:
-* plugin version (e.g. smart-doc-maven-plugin or smart-doc-gradle-plugin):
-* build tool version(maven or gradle):
-
-## Expected Behavior(您期望的结果)
-
-<!--- If you're describing a bug, tell us what should happen -->
-<!--- If you're suggesting a change/improvement, tell us how it should work -->
-
-## Current Behavior(当前结果)
-
-<!--- If describing a bug, tell us what happens instead of the expected behavior -->
-<!--- If suggesting a change/improvement, explain the difference from current behavior -->
-
-## Possible Solution(bug解决建议)
-
-<!--- Not obligatory, but suggest a fix/reason for the bug, -->
-<!--- or ideas how to implement the addition or change -->
-
-## Steps to Reproduce (Bug产生步骤，请尽量提供用例代码)
-
-<!--- Provide a link to a live example, or an unambiguous set of steps to -->
-<!--- reproduce this bug. Include code to reproduce, if relevant -->
-
-1.
-2.
-3.
-4.
-
-## Context(Bug影响描述)
-
-<!--- How has this issue affected you? What are you trying to accomplish? -->
-<!--- Providing context helps us come up with a solution that is most useful in the real world -->
-
-
-