Skip to content

Commit

Permalink
add issue templates for bug report and feature request. (#9)
Browse files Browse the repository at this point in the history
  • Loading branch information
naskio authored Sep 17, 2023
1 parent 01fe240 commit c21717c
Show file tree
Hide file tree
Showing 2 changed files with 93 additions and 0 deletions.
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: Bug Report
description: Create a bug report to help us improve ParquetSharp.DataFrame
title: "[BUG]: <title>"
labels: [ "Bug" ]

body:
- type: markdown
attributes:
value: |
**Thank you for reporting this issue!**
To help us understand and address the problem effectively, please provide detailed information.
You can refer to [this guide](https://stackoverflow.com/help/mcve) for tips on creating a good bug report.
- type: textarea
id: issue-description
attributes:
label: Issue Description
description: A clear and concise description of the issue
validations:
required: true

- type: textarea
id: environment-information
attributes:
label: Environment Information
description: "Please provide the following details:"
value: |
- ParquetSharp.DataFrame Version: [e.g. 0.1.0]
- ParquetSharp Version: [e.g. 11.0.0]
- .NET Framework/SDK Version: [e.g. .NET Framework 4.7.2]
- Operating System: [e.g. Windows 10]
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: Steps To Reproduce
description: Detailed steps to reproduce the behavior
placeholder: |
1. Provide a minimal code example or steps.
2. Explain the exact error message or current behavior.
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true

- type: textarea
id: additional-context
attributes:
label: Additional Context (Optional)
description: Add any other context about the problem here, including log outputs or screenshots if applicable.
validations:
required: false
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Feature Request
description: Suggest a new idea for ParquetSharp.DataFrame
title: "[FEATURE REQUEST]: <title>"
labels: [ "Feature Request" ]

body:
- type: textarea
id: related-problem
attributes:
label: Is your feature request related to a problem? Please describe.
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
validations:
required: true

- type: textarea
id: describe-solution
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
validations:
required: true

- type: textarea
id: describe-alternatives
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.

0 comments on commit c21717c

Please sign in to comment.