-
Notifications
You must be signed in to change notification settings - Fork 56
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
github issue and PR templates (#1040)
Co-authored-by: Adam Hearn <[email protected]>
- Loading branch information
Showing
3 changed files
with
128 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
<!-- | ||
PRs require an approval from any of the core contributors, other than the PR author. | ||
Include this header if applicable: | ||
Fixes #issue1, #issue2, ... | ||
--> | ||
|
||
### Problem | ||
<!-- | ||
Explain here the context, and why you're making this change. What is the problem you're trying to solve? | ||
--> | ||
|
||
### Solution | ||
<!-- | ||
Describe your solution. Focus on helping reviewers understand your technical approach and implementation decisions. | ||
--> | ||
|
||
### Notes | ||
<!-- | ||
Add any important additional information as bullet points, such as: | ||
- Implementation details reviewers should know about | ||
- Open questions and concerns | ||
- Limitations | ||
--> | ||
|
||
### Checklist | ||
|
||
- [ ] Unit test all changes | ||
- [ ] Update scaladocs if needed | ||
- [ ] Update the README if needed |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
name: Bug Report | ||
description: File a bug report | ||
title: "[BUG]: " | ||
labels: ["bug"] | ||
body: | ||
- type: input | ||
id: version | ||
attributes: | ||
label: Version | ||
description: What version of Kyo are you using? | ||
placeholder: e.g. 0.16.0 | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
id: scala-version | ||
attributes: | ||
label: Scala Version | ||
description: What version of Scala are you using? | ||
placeholder: e.g. 3.6.2 | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: expected | ||
attributes: | ||
label: Expected Behavior | ||
description: What should happen? Be specific about the expected outcome. | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
id: actual | ||
attributes: | ||
label: Actual Behavior | ||
description: What went wrong? Include error messages, stack traces, or logs if relevant. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: reproduction | ||
attributes: | ||
label: Steps to Reproduce | ||
description: Please provide a step by step guide to reproduce the issue. Include minimal code examples and any specific configuration or environment details needed. | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
id: workaround | ||
attributes: | ||
label: Current Workaround | ||
description: If you've found a temporary solution, describe it here to help others encountering the same issue. | ||
validations: | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
name: Feature Request | ||
description: Suggest a new feature or enhancement | ||
title: "[feature]: " | ||
labels: ["feature"] | ||
body: | ||
- type: textarea | ||
id: problem | ||
attributes: | ||
label: Problem Statement | ||
description: What problem does this feature solve? Please describe the use case. | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
id: proposed-solution | ||
attributes: | ||
label: Proposed Solution | ||
description: Describe the solution you'd like to see. Include example API usage if possible. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: alternatives | ||
attributes: | ||
label: Alternative Solutions | ||
description: Describe any alternative solutions or features you've considered. | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
id: current-workaround | ||
attributes: | ||
label: Current Workaround | ||
description: How are you currently working around this limitation? | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
id: additional-context | ||
attributes: | ||
label: Additional Context | ||
description: Add any other context, examples, or references about the feature request here. | ||
validations: | ||
required: false |