Add issue templates (#537)

* Update issue templates * Added issue templates config in YAML * Fix a typo * Fix the type of the block * Make Python version requred; clear old files * Add a PR template * Convert dlt version into an input field
2025-12-17 19:31:30 +00:00 · 2023-08-28 15:40:57 +02:00
parent 3c0cc18ad1
commit a9aa23e2b2
4 changed files with 194 additions and 0 deletions
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,119 @@
+---
+name: Bug Report
+description: Report a problem with dlt
+labels: ["kind:bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for reporting a bug for dlt! Please fill out the sections below.
+        If you are not sure if this is a bug or not, please join our [Slack](https://join.slack.com/t/dlthub-community/shared_invite/zt-1slox199h-HAE7EQoXmstkP_bTqal65g)
+        and ask in the #3-technical-help channel.
+  - type: input
+    attributes:
+      label: dlt version
+      description: What dlt version are you using? You can find this information in the output of `dlt --version`.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Describe the problem
+      description: Outline the problem or issue you encountered.
+      placeholder: >
+        Share the context in which the issue occurred, and details of what happened.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Expected behavior
+      description: Describe your expectation of how dlt should behave.
+      placeholder: >
+        Elaborate on why you believe the observed behavior is incorrect. Including exact error messages,
+        log fragments or screenshots. Attach files by dragging and dropping here.
+  - type: textarea
+    attributes:
+      label: Steps to reproduce
+      description: >
+        How can we replicate the issue? If it's not straightforward to reproduce, please join our [Slack](https://join.slack.com/t/dlthub-community/shared_invite/zt-1slox199h-HAE7EQoXmstkP_bTqal65g)
+        and ask in the #3-technical-help channel.
+      placeholder: >
+        Provide a step-by-step description of how to reproduce the problem you are running into.
+        Please be as specific as possible by providing a link to a public repository with a
+        minimalistic reproducer or a code snippet that can be used to reproduce the problem.
+    validations:
+      required: true
+  - type: dropdown
+    attributes:
+      label: Operating system
+      description: What operating system are you using?
+      multiple: true
+      options:
+        - "Linux"
+        - "macOS"
+        - "Windows"
+        - "Other"
+    validations:
+      required: true
+  - type: dropdown
+    attributes:
+      label: Runtime environment
+      description: >
+        What kind of deployment do you have? If you use a Managed Service, consider first using regular
+        channels of reporting issues for the service.
+      multiple: false
+      options:
+        - "Local"
+        - "Virtual Machine"
+        - "Docker, Docker Compose"
+        - "Kubernetes"
+        - "Airflow"
+        - "Astronomer"
+        - "Google Cloud Composer"
+        - "Google Colab"
+        - "GitHub Codespaces"
+        - "Other"
+    validations:
+      required: true
+  - type: dropdown
+    attributes:
+      label: Python version
+      description: What Python version are you using?
+      multiple: false
+      options:
+        - "3.11"
+        - "3.10"
+        - "3.9"
+        - "3.8"
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: dlt data source
+      description: What data source are you using?
+      placeholder: >
+        E.g. dlt verified source, API, CSV, etc.
+  - type: dropdown
+    attributes:
+      label: dlt destination
+      description: What type of destination are you using?
+      multiple: true
+      options:
+        - Google BigQuery
+        - DuckDB
+        - Filesystem & buckets
+        - Postgres
+        - Amazon Redshift
+        - Snowflake
+        - AWS Athena / Glue Catalog
+        - MotherDuck
+        - Weaviate
+  - type: textarea
+    attributes:
+      label: Other deployment details
+      description: Offer more details about your deployment.
+  - type: textarea
+    attributes:
+      label: Additional information
+      description: Is there anything else you'd like us to know?
+      placeholder: >
+        E.g. issue frequency, workarounds, related issues, suggestions on how to fix, etc.
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,6 @@
+---
+blank_issues_enabled: true
+contact_links:
+  - name: Ask a question or get support on dlt Slack
+    url: https://join.slack.com/t/dlthub-community/shared_invite/zt-1slox199h-HAE7EQoXmstkP_bTqal65g
+    about: Need help or support? Join our dlt community on Slack and get assistance.
--- a/.github/ISSUE_TEMPLATE/feature_request.yml
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,44 @@
+---
+name: Feature Request
+description: Suggest a feature for dlt
+labels: ["kind:enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for suggesting a feature for dlt!
+        If you like to discuss your idea first, please join our [Slack](https://join.slack.com/t/dlthub-community/shared_invite/zt-1slox199h-HAE7EQoXmstkP_bTqal65g)
+        and pose your questions in the #3-technical-help channel.
+        For minor features and improvements, feel free to open a [pull request](https://github.com/dlt-hub/dlt/pulls) directly.
+  - type: textarea
+    attributes:
+      label: Feature description
+      description: Describe the feature you'd like to see.
+      placeholder: >
+        What would you like to happen?
+  - type: dropdown
+    attributes:
+      label: Are you a dlt user?
+      description: Please tell us how you are using dlt.
+      multiple: false
+      options:
+        - "Yes, I'm already a dlt user."
+        - "Yes, I run dlt in production."
+        - "Yes, I use it for fun."
+        - "I'd consider using dlt, but it's lacking a feature I need."
+  - type: textarea
+    attributes:
+      label: Use case
+      description: Is your feature request related to a problem? Please describe.
+      placeholder: >
+        What problem are you trying to solve?
+  - type: textarea
+    attributes:
+      label: Proposed solution
+      description: Describe the solution you'd like to see.
+      placeholder: >
+        What would you like to see changed?
+  - type: textarea
+    attributes:
+      label: Related issues
+      description: Is there currently another issue associated with this?
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,25 @@
+<!--
+Thank you for submitting a pull request! Please provide a brief description of your changes below.
+-->
+### Description
+
+
+<!--
+Please link any related issues. This helps us keep the PR focused and merge it faster.
+-->
+### Related Issues
+
+- Fixes #...
+- Closes #...
+- Resolves #...
+
+<!--
+Provide any additional context about the PR here.
+-->
+### Additional Context
+
+<!--
+Please ensure that
+    - you have read the [Contributing to dlt](../CONTRIBUTING.md) guide.
+    - you have run the tests locally and they have passed before submitting your PR.
+-->