diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..bd0ecc5a8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,30 @@ + + +### Problem + + +### Solution + + +### Notes + + +### Checklist + +- [ ] Unit test all changes +- [ ] Update scaladocs if needed +- [ ] Update the README if needed diff --git a/.github/workflows/ISSUE_TEMPLATE/01-bug-report.yml b/.github/workflows/ISSUE_TEMPLATE/01-bug-report.yml new file mode 100644 index 000000000..b840dd93d --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/01-bug-report.yml @@ -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 \ No newline at end of file diff --git a/.github/workflows/ISSUE_TEMPLATE/02-feature-request.yml b/.github/workflows/ISSUE_TEMPLATE/02-feature-request.yml new file mode 100644 index 000000000..571c0e6c9 --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/02-feature-request.yml @@ -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 \ No newline at end of file