diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..dd84ea782 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**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 + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**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. diff --git a/.github/ISSUE_TEMPLATE/custom-rule.md b/.github/ISSUE_TEMPLATE/custom-rule.md new file mode 100644 index 000000000..5a6134d62 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/custom-rule.md @@ -0,0 +1,37 @@ +--- +name: Custom rule +about: Regarding the demand for customized rules and false positives and negatives. +title: '' +labels: '' +assignees: '' + +--- + +**Describe the demand** +A clear and concise description of what the rule is. + + +**规则概述(Rules Overview)** + + +**规则背景(Rule Background)** +代码的功能逻辑,按步骤书写。(The functional logic of the code is written in steps.) + + +**目标问题点(Target Problem Points)** +- 可以按照场景来阐述,比如场景1、场景2这样;(It can be explained by scenario, such as scenario 1 and scenario 2;) +- 每个场景中是第几个步骤可能出现问题,想要解决/检测什么,可以怎么修复,可以结合右边的Case解释。(In each scenario, which step may cause a problem, what you want to solve/detect, and how to fix it. You can explain it in conjunction with the case on the right.) + + +**错误代码示例(Bad Case)** + + +**正确代码示例(Good Case)** + + +**TCA官网上测试项目链接(TCA official website test project link)** +tca.tencent.com + + +**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 new file mode 100644 index 000000000..bbcbbe7d6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**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 [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here.