Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
138 changes: 138 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
name: 🐛 Bug Report
description: Report a bug or unexpected behavior in sqlalchemy-redshift
title: "[Bug]: "
labels: ["bug", "needs-triage"]
assignees: []

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug! Please fill out the information below to help us diagnose and fix the issue.

- type: checkboxes
id: checklist
attributes:
label: Pre-submission checklist
options:
- label: I have searched existing issues to ensure this bug has not been reported before
required: true
- label: I have read the documentation and confirmed this is not expected behavior
required: true
- label: I am using a supported version of sqlalchemy-redshift (0.8.x)
required: true

- type: textarea
id: description
attributes:
label: Bug Description
description: A clear and concise description of what the bug is.
placeholder: Describe the bug here...
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Steps to Reproduce
description: Steps to reproduce the behavior
placeholder: |
1. Import sqlalchemy_redshift
2. Create engine with '...'
3. Execute query '...'
4. See error
validations:
required: true

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

- type: textarea
id: actual
attributes:
label: Actual Behavior
description: What actually happened instead?
validations:
required: true

- type: textarea
id: code
attributes:
label: Code Sample
description: Please provide a minimal, reproducible code sample
render: python
placeholder: |
import sqlalchemy as sa
from sqlalchemy_redshift import dialect

# Your code here...

- type: textarea
id: error
attributes:
label: Error Output
description: If applicable, paste the full error message and traceback
render: text
placeholder: Paste error output here...

- type: dropdown
id: python_version
attributes:
label: Python Version
description: What version of Python are you using?
options:
- "3.11"
- "3.12"
- "3.13"
- "Other (please specify in additional context)"
validations:
required: true

- type: input
id: sqlalchemy_redshift_version
attributes:
label: sqlalchemy-redshift Version
description: What version of sqlalchemy-redshift are you using?
placeholder: "0.8.14"
validations:
required: true

- type: input
id: sqlalchemy_version
attributes:
label: SQLAlchemy Version
description: What version of SQLAlchemy are you using?
placeholder: "2.0.43"
validations:
required: true

- type: input
id: redshift_version
attributes:
label: Redshift Version/Type
description: Are you using Redshift Cluster, Serverless, or something else?
placeholder: "Redshift Serverless"

- type: dropdown
id: os
attributes:
label: Operating System
description: What operating system are you using?
options:
- "Linux"
- "macOS"
- "Windows"
- "Other (please specify in additional context)"
validations:
required: true

- type: textarea
id: additional_context
attributes:
label: Additional Context
description: Add any other context about the problem here, including configuration details, environment setup, etc.
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: 📚 Documentation
url: https://sqlalchemy-redshift.readthedocs.io/
about: Check the documentation for usage examples and API reference
- name: 💬 Discussions
url: https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/discussions
about: Ask questions and discuss ideas with the community
- name: 🔒 Security Issues
url: https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/security/advisories/new
about: Report security vulnerabilities privately
138 changes: 138 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
name: ✨ Feature Request
description: Suggest a new feature or enhancement for sqlalchemy-redshift
title: "[Feature]: "
labels: ["enhancement", "needs-triage"]
assignees: []

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to suggest a feature! Please provide as much detail as possible to help us understand and evaluate your request.

- type: checkboxes
id: checklist
attributes:
label: Pre-submission checklist
options:
- label: I have searched existing issues to ensure this feature has not been requested before
required: true
- label: I have read the documentation to confirm this functionality doesn't already exist
required: true
- label: This feature request is related to sqlalchemy-redshift functionality
required: true

- type: textarea
id: summary
attributes:
label: Feature Summary
description: A brief, clear summary of the feature you'd like to see
placeholder: What feature would you like to see added?
validations:
required: true

- type: textarea
id: problem
attributes:
label: Problem Statement
description: What problem does this feature solve? What is the current limitation?
placeholder: |
Describe the problem or limitation you're facing...

For example:
- "Currently, there's no way to..."
- "When working with X, it's difficult to..."
- "Users have to manually..."
validations:
required: true

- type: textarea
id: solution
attributes:
label: Proposed Solution
description: Describe the solution you'd like to see implemented
placeholder: |
Describe your preferred solution in detail...

For example:
- "Add a new method/function that..."
- "Extend the existing X to support..."
- "Provide a configuration option for..."
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternative Solutions
description: Have you considered any alternative solutions or workarounds?
placeholder: |
Describe any alternative solutions you've considered...

Current workarounds you might be using...

- type: dropdown
id: priority
attributes:
label: Priority
description: How important is this feature to you?
options:
- "Low - Nice to have"
- "Medium - Would be helpful"
- "High - Important for my use case"
- "Critical - Blocking my work"
validations:
required: true

- type: dropdown
id: complexity
attributes:
label: Estimated Complexity
description: How complex do you think this feature would be to implement?
options:
- "Low - Small change or addition"
- "Medium - Moderate development effort"
- "High - Significant change or new functionality"
- "I'm not sure"

- type: textarea
id: use_case
attributes:
label: Use Case
description: Describe your specific use case and how this feature would help
placeholder: |
Provide details about your specific use case:
- What are you trying to accomplish?
- How would this feature fit into your workflow?
- Are there other users who would benefit from this?

- type: textarea
id: example
attributes:
label: Code Example
description: If applicable, provide a code example showing how you'd like to use this feature
render: python
placeholder: |
# Example of how the feature might be used
import sqlalchemy as sa
from sqlalchemy_redshift import dialect

# Your example code here...

- type: dropdown
id: contribution
attributes:
label: Contribution
description: Would you be interested in contributing to the implementation of this feature?
options:
- "Yes, I'd like to work on this"
- "Yes, I could help with testing"
- "Yes, I could help with documentation"
- "Maybe, depending on complexity"
- "No, I'm not able to contribute"

- type: textarea
id: additional_context
attributes:
label: Additional Context
description: Add any other context, links, or screenshots about the feature request here
66 changes: 66 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
name: ❓ Question
description: Ask a question about using sqlalchemy-redshift
title: "[Question]: "
labels: ["question", "needs-triage"]
assignees: []

body:
- type: markdown
attributes:
value: |
Have a question about using sqlalchemy-redshift? We're here to help!

- type: checkboxes
id: checklist
attributes:
label: Pre-submission checklist
options:
- label: I have read the documentation and couldn't find the answer
required: true
- label: I have searched existing issues and discussions
required: true

- type: textarea
id: question
attributes:
label: Question
description: What would you like to know?
placeholder: Ask your question here...
validations:
required: true

- type: textarea
id: context
attributes:
label: Context
description: Provide any relevant context about what you're trying to accomplish
placeholder: |
What are you trying to do?
What have you already tried?
Any relevant background information?

- type: textarea
id: code
attributes:
label: Code Sample
description: If applicable, provide a code sample related to your question
render: python
placeholder: |
import sqlalchemy as sa
from sqlalchemy_redshift import dialect

# Your code here...

- type: input
id: sqlalchemy_redshift_version
attributes:
label: sqlalchemy-redshift Version
description: What version are you using?
placeholder: "0.8.14"

- type: input
id: sqlalchemy_version
attributes:
label: SQLAlchemy Version
description: What version of SQLAlchemy are you using?
placeholder: "2.0.43"
Loading
Loading