Skip to content

Commit c503e6e

Browse files
author
ffffwh
committed
update bug template
1 parent 4064e89 commit c503e6e

File tree

4 files changed

+27
-58
lines changed

4 files changed

+27
-58
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+24-39
Original file line numberDiff line numberDiff line change
@@ -5,63 +5,48 @@ about: Create a report to help us improve
55
---
66

77
<!--
8-
If you are reporting a new issue, make sure that we do not have any duplicates
9-
already open. You can ensure this by searching the issue list for this
10-
repository. If there is a duplicate, please close your issue and add a comment
11-
to the existing issue instead.
8+
Before reporting an issue, make a search and ensure there is no similar existing issue. If there is one, you can comment there.
129
13-
If you suspect your issue is a bug, please edit your issue description to
14-
include the BUG REPORT INFORMATION shown below.
10+
The GitHub issue tracker is for bug reports and feature requests. **Do not ask for usage or error solution here.** General support for **Dtle** can be found at:
1511
16-
For more information about reporting issues, see
17-
https://github.com/actiontech/dtle/blob/master/CONTRIBUTING.md#reporting-other-issues
18-
19-
---------------------------------------------------
20-
GENERAL SUPPORT INFORMATION
21-
---------------------------------------------------
22-
23-
The GitHub issue tracker is for bug reports and feature requests.
24-
General support for **Dtle** can be found at the following locations:
25-
26-
- Dtle Support QQ Group - 852990221
27-
28-
---------------------------------------------------
29-
BUG REPORT INFORMATION
30-
---------------------------------------------------
31-
Use the commands below to provide key information from your environment:
32-
You do NOT have to include this information if this is a FEATURE REQUEST
12+
- Dtle Support QQ Group: 852990221
3313
-->
3414

35-
**Description**
15+
## Description
3616

3717
<!--
38-
Briefly describe the problem you are having in a few paragraphs.
18+
Briefly describe the problem in a few paragraphs.
3919
-->
4020

41-
**Steps to reproduce the issue:**
42-
1.
43-
2.
44-
3.
21+
## Steps to reproduce the issue
22+
1.
23+
2.
24+
3.
4525

46-
**Describe the results you received:**
26+
## Describe the results you received
4727

4828

49-
**Describe the results you expected:**
29+
## Describe the results you expected
5030

51-
**Output of `./dtle version`:**
31+
## Output of `./dtle version`:**
5232

5333
```
5434
(paste your output here)
5535
```
5636

57-
**Additional information you deem important (e.g. issue happens only occasionally):**
37+
## Additional information
38+
39+
(e.g. issue happens only occasionally)
5840

5941

60-
**Additional details (log, config, job config etc):**
61-
<!--
62-
1. default config path: /etc/dtle/dtle.conf
63-
2. job config: curl -XGET "http://127.0.0.1:8190/v1/job/<job_uuid>"
64-
3. default log path: /var/log/dtle.log
42+
## Additional details (log, config, job config etc):
43+
<!--
44+
1. default file path
45+
- config: /etc/dtle/dtle.conf
46+
- log: /var/log/dtle.log
47+
- job: your local file, or get from dtle
48+
- curl -XGET "http://127.0.0.1:8190/v1/job/<job_uuid>"
6549
4. mask sensitive infomation (e.g. IP, username and password)"
66-
5. try to be complete and compress if needed
50+
5. paste short files or the key part
51+
6. provide large files as attachments (compress if necessary)
6752
-->

.github/ISSUE_TEMPLATE/feature_request.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ about: Suggest an idea for this project
44

55
---
66

7-
**Is your feature request related to a problem? Please describe.**
7+
## Is your feature request related to a problem?
88
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
99

10-
**Describe the solution you'd like**
10+
## Describe the solution you'd like
1111
A clear and concise description of what you want to happen.
1212

13-
**Describe alternatives you've considered**
13+
## Describe alternatives you've considered
1414
A clear and concise description of any alternative solutions or features you've considered.

.gitlab/issue_templates/.gitkeep

Whitespace-only changes.

.gitlab/issue_templates/Bug.md

-16
This file was deleted.

0 commit comments

Comments
 (0)