smart-doc/.github/ISSUE_TEMPLATE/bug_report.md

40 lines
1.3 KiB
Markdown
Raw Normal View History

2020-07-01 14:48:23 +08:00
---
name: Bug report 🐞
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''
---
2020-12-06 13:37:55 +08:00
## 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):
2020-07-01 15:07:35 +08:00
## 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 -->
2020-07-01 15:18:15 +08:00
## Steps to Reproduce (Bug产生步骤请尽量提供用例代码)
2020-07-01 15:07:35 +08:00
<!--- 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.
2020-07-01 15:18:15 +08:00
## Context(Bug影响描述)
2020-07-01 15:07:35 +08:00
<!--- 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 -->
2020-12-06 13:37:55 +08:00
2020-07-01 15:07:35 +08:00