Skip to content

Commit

Permalink
update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
osiegmar committed Sep 14, 2024
1 parent 519ed4a commit 419778f
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 18 deletions.
40 changes: 31 additions & 9 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,39 @@ about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.
<!--
Please make sure to only report bugs here!
If you have a question or need help, use the Discussions tab instead.
**To Reproduce**
JUnit test to reproduce the behavior:
```
insert test code here
For any code examples, please use Markdown code blocks with syntax highlighting like this:
```java
System.out.println("Hello, World!");
```
-->

### Description

<!-- A clear and concise description of what the bug is. -->

### Current Behavior

<!-- Describe what is currently happening. -->

### Expected Behavior

<!-- Describe what you expected to happen. -->
<!-- If not obvious, please tell why you expected that behavior. -->

### Steps to Reproduce

<!-- Please share a code snippet (ideally, a unit test) to reproduce the issue. -->
<!-- Remember to include/attach the input data if needed. -->

### Additional Context

**Additional context**
Java distribution and version to be used (output of `java -version`).
- Operating system: Windows, Linux, macOS
- FastCSV version: X.X.X
- Java version: X.X.X (output of `java -version`)
24 changes: 15 additions & 9 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,23 @@ 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 [...]
### 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

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

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
### Goal alignment

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

0 comments on commit 419778f

Please sign in to comment.