Skip to content

Commit

Permalink
Update the issue templates (#393)
Browse files Browse the repository at this point in the history
  • Loading branch information
VioletM authored Apr 2, 2024
1 parent 079a59f commit 83c50a1
Show file tree
Hide file tree
Showing 5 changed files with 239 additions and 58 deletions.
109 changes: 109 additions & 0 deletions .github/ISSUE_TEMPLATE/1_bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
---
name: Bug Report
description: Report a problem with dlt source
labels: ["kind:bug"]
body:
- type: markdown
attributes:
value: |
Thanks for reporting a bug for dlt verified-sources! Please fill out the sections below.
If you are not sure if this is a bug or not, please join our [Slack](https://dlthub.com/community)
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: input
attributes:
label: Source name
description: Name of the affected source as displayed by `dlt init` or present in `sources` folder of this repo.
validations:
required: true
- type: textarea
attributes:
label: Describe the problem
description: Outline the problem or issue you encountered. Please, provide the name of resource causing the trouble and any stack traces and logs you can share.
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 source 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://dlthub.com/community)
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: How you are using the source?
description: Please tell us how you use dlt and how this impacts your need for this bug to be fixed.
multiple: false
options:
- "I run this source in production."
- "I run this source for fun."
- "I'm considering using this source in my work, but bug is preventing this."
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: input
attributes:
label: Python version
description: What Python version are you using?
validations:
required: true
- type: input
attributes:
label: dlt destination
description: What type of destination are you using?
- 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.
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/2_extend_source.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
name: Extend a source
description: Request extension of existing source
labels: ["source new feature"]
body:
- type: markdown
attributes:
value: |
If you want existing source to be extended, please fill out the sections below.
If you are not sure, please join our [Slack](https://dlthub.com/community)
and ask in the #3-technical-help channel.
validations:
required: true
- type: input
attributes:
label: Source name
description: Name of the affected source as displayed by `dlt init` or present in `sources` folder of this repo.
validations:
required: true
- type: textarea
attributes:
label: Describe the data you'd like to see
description: Describe the data you want to be added to dlt source. Please, be specific, link the docs.
placeholder: >
Provide the description of data you want to be added.
validations:
required: true
- type: dropdown
attributes:
label: Are you a dlt user?
description: Please tell us how you use dlt and how this impacts your need for this additional data.
multiple: false
options:
- "Yes, I'm already a dlt user."
- "Yes, I run dlt in production."
- "Yes, I use it for fun."
- "I'm considering using dlt, but this bug is preventing this."
validations:
required: true
- type: dropdown
attributes:
label: Do you ready to contribute this extension?
description: Please tell if you are ready to contribute code to verified sources.
multiple: false
options:
- "Yes, I'm ready."
- "Yes, but I need help."
- "No."
validations:
required: true
- type: input
attributes:
label: dlt destination
description: What type of destination are you using?
- 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.
70 changes: 70 additions & 0 deletions .github/ISSUE_TEMPLATE/3_source_resuest.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
name: Source request
description: Request a new verified source.
labels: ["source request"]
body:
- type: markdown
attributes:
value: |
If you want to request new source, please make sure you've checked the `sources` folder of this repo
or `dlt init -l` listing and requested source is not there.
If you need any help, join our [Slack](https://dlthub.com/community)
and ask in the #3-technical-help channel.
validations:
required: true
- type: input
attributes:
label: Source name
description: Name of the affected source as displayed by `dlt init` or present in `sources` folder of this repo.
validations:
required: true
- type: textarea
attributes:
label: Describe the source data.
description: Briefly describe what is the data used in this source. Is it an API? Other database? Link relevant information.
placeholder: >
Provide the description of the source.
validations:
required: true
- type: dropdown
attributes:
label: What is your plan for this source.
description: Please tell us what is the purpose of this source.
multiple: false
options:
- "I want to run it myself"
- "I need the data for my hobby project"
- "I need the data for my work"
- "I want to run it in production"
validations:
required: true
- type: textarea
attributes:
label: Use case
description: Please, provide up to 3 use case description, that is not only targeted at the developers but also by people creating test account and doing demos.
placeholder: >
Provide up to 3 use cases for this source.
validations:
required: true
- type: textarea
attributes:
label: Describe the desired tables.
description: Describe the data you need in terms of tables. Describe how it should be loaded, which resources you want to see.
placeholder: >
Provide description of the resulting tables.
validations:
required: true
- type: textarea
attributes:
label: Who else will benefit?
description: Please tell us who else could use this source? It could be general description of companies, groups of people of specific companies.
placeholder: >
Who else will benefit?
validations:
required: true
- 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.
40 changes: 0 additions & 40 deletions .github/ISSUE_TEMPLATE/bug-report.md

This file was deleted.

18 changes: 0 additions & 18 deletions .github/ISSUE_TEMPLATE/extend-a-source.md

This file was deleted.

0 comments on commit 83c50a1

Please sign in to comment.