Skip to content

Commit 419778f

Browse files
committed
update issue templates
1 parent 519ed4a commit 419778f

File tree

2 files changed

+46
-18
lines changed

2 files changed

+46
-18
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,39 @@ about: Create a report to help us improve
44
title: ''
55
labels: ''
66
assignees: ''
7-
87
---
98

10-
**Describe the bug**
11-
A clear and concise description of what the bug is.
9+
<!--
10+
Please make sure to only report bugs here!
11+
If you have a question or need help, use the Discussions tab instead.
1212
13-
**To Reproduce**
14-
JUnit test to reproduce the behavior:
15-
```
16-
insert test code here
13+
For any code examples, please use Markdown code blocks with syntax highlighting like this:
14+
15+
```java
16+
System.out.println("Hello, World!");
1717
```
18+
-->
19+
20+
### Description
21+
22+
<!-- A clear and concise description of what the bug is. -->
23+
24+
### Current Behavior
25+
26+
<!-- Describe what is currently happening. -->
27+
28+
### Expected Behavior
29+
30+
<!-- Describe what you expected to happen. -->
31+
<!-- If not obvious, please tell why you expected that behavior. -->
32+
33+
### Steps to Reproduce
34+
35+
<!-- Please share a code snippet (ideally, a unit test) to reproduce the issue. -->
36+
<!-- Remember to include/attach the input data if needed. -->
37+
38+
### Additional Context
1839

19-
**Additional context**
20-
Java distribution and version to be used (output of `java -version`).
40+
- Operating system: Windows, Linux, macOS
41+
- FastCSV version: X.X.X
42+
- Java version: X.X.X (output of `java -version`)

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,23 @@ about: Suggest an idea for this project
44
title: ''
55
labels: ''
66
assignees: ''
7-
87
---
98

10-
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
9+
### Is your feature request related to a problem? Please describe.
10+
11+
<!--
12+
A clear and concise description of what the problem is.
13+
Ex. I'm always frustrated when [...]
14+
-->
15+
16+
### Describe the solution you'd like
17+
18+
<!-- A clear and concise description of what you want to happen. -->
19+
20+
### Describe alternatives you've considered
1221

13-
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
22+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
1523

16-
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
24+
### Goal alignment
1825

19-
**Goal alignment**
20-
Does this feature align with the [goals](https://www.fastcsv.org/architecture/goals/) of FastCSV?
26+
<!-- Does this feature align with the Goals (https://www.fastcsv.org/architecture/goals/) of FastCSV? -->

0 commit comments

Comments
 (0)