jprdonnelly/airbyte
1
0
Fork 0
mirror of synced 2025-12-19 18:14:56 -05:00
Code Issues Packages Projects Releases Wiki Activity

ISSUE TEMPLATE: rename issues template and add specific order to them (#25926)

Browse Source 
* Update issue-platform.yaml

* make deploy method require

* Update issue-platform.yaml

* Update issue-platform.yaml

* Update issue-platform.yaml

* Update issue-platform.yaml

* Update issue-platform.yaml

Make octavia bigger

* Update issue-platform.yaml

* Update issue-platform.yaml

* redesign issue templates and names

* nits

---------

Co-authored-by: Sunny Hashmi <6833405+sh4sh@users.noreply.github.com>
This commit is contained in:
Marcos Marx
2023-05-09 18:17:39 -03:00
committed by GitHub
parent ba1589808f
commit 9dc443db60
13 changed files with 219 additions and 182 deletions
Download Patch File Download Diff File Expand all files Collapse all files

73
.github/ISSUE_TEMPLATE/1-issue-connector.yaml vendored Normal file
View File

@@ -0,0 +1,73 @@
name: 🪲 Report a connector problem
description: Use this template to report a problem using source or a destination connector
labels: [type/bug, area/connectors, needs-triage]
body:
- type: markdown
attributes:
value: >
<p align="center">
<a target="_blank" href="https://airbyte.com">
<picture>
<source srcset="https://assets-global.website-files.com/605e01bc25f7e19a82e74788/621e2495cb90b8b2c3b31b0d_airbyte-octo-p-500.png">
<img alt="airbyte octavia" src="https://assets-global.website-files.com/605e01bc25f7e19a82e74788/621e2495cb90b8b2c3b31b0d_airbyte-octo-p-500.png" width="auto" height="150">
</picture>
</a>
</p>
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report...
Make sure you update this issue with a concise title and provide all information you have to
help us debug the problem together.
Issues not following the template will be closed.
- type: input
id: connector-name
attributes:
label: Connector Name
description: |
Insert only the name of the connector is having issue.
Use the pattern source-postgres or destination-postgres.
This will help us automatically label the issue to the correct teams.
placeholder: destination-mssql
validations:
required: true
- type: input
id: connector-version
attributes:
label: Connector Version
description: Give the connector version that has a problem. You can find it in the sync log file or the settings page.
placeholder: 0.2.63
validations:
required: true
- type: dropdown
id: step
attributes:
label: What step the error happened?
multiple: false
options:
- Configuring a new connector
- During the sync
- Updating the connector
- Other
- type: textarea
id: description
attributes:
label: Revelant information
description: Please give any additional information you have and steps to reproduce the problem.
- type: textarea
id: logs
attributes:
label: Relevant log output
description: |
Please copy and paste any relevant log output.
This will be automatically formatted into code, so no need for backticks.
We strongly recommend to upload the log file for further debugging.
render: shell
- type: checkboxes
id: submit-pr
attributes:
label: Contribute
description: Are you willing to submit the fix?
options:
- label: Yes, I want to contribute
required: false

62
.github/ISSUE_TEMPLATE/2-issue-platform.yaml vendored Normal file
View File

@@ -0,0 +1,62 @@
name: 🪲 Report a platform, infra or deployment bug
description: Use this template when you have a problem operating Airbyte platform
labels: [type/bug, area/platform, needs-triage]
body:
- type: markdown
attributes:
value: >
<p align="center">
<a target="_blank" href="https://airbyte.com">
<picture>
<source srcset="https://assets-global.website-files.com/605e01bc25f7e19a82e74788/621e2495cb90b8b2c3b31b0d_airbyte-octo-p-500.png">
<img alt="airbyte octavia" src="https://assets-global.website-files.com/605e01bc25f7e19a82e74788/621e2495cb90b8b2c3b31b0d_airbyte-octo-p-500.png" width="auto" height="150">
</picture>
</a>
</p>
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report...
Make sure to update this issue with a concise title and provide all information you have to
help us debug the problem together. Issues not following the template will be closed.
- type: dropdown
id: deploy
validations:
required: true
attributes:
label: What method are you using to run Airbyte?
multiple: false
options:
- Docker
- Kubernetes
- type: input
id: platform-version
attributes:
label: Platform Version or Helm Chart Version
description: "Some examples are: (eg. 0.44.1, 0.30.0), you can find the version in the left bottom in Airbyte UI or in the .env / value.yaml file"
validations:
required: true
- type: dropdown
id: step
attributes:
label: What step the error happened?
multiple: false
options:
- On deploy
- During the Sync
- Upgrading the Platform or Helm Chart
- Other
- type: textarea
id: description
attributes:
label: Revelant information
description: Please give any additional information you have and steps to reproduce the problem.
- type: textarea
id: logs
attributes:
label: Relevant log output
description: |
Please copy and paste any relevant log output.
This will be automatically formatted into code, so no need for backticks.
We strongly recommend to upload the log file for further debugging.
render: shell

42
.github/ISSUE_TEMPLATE/3-issue-cli.yaml vendored Normal file
View File

@@ -0,0 +1,42 @@
name: 🪲 Report a problem while using the Octavia CLI
description: Use this template when you discovered a CLI problem
labels: [type/bug, area/octavia-cli, needs-triage]
body:
- type: markdown
attributes:
value: >
<p align="center">
<a target="_blank" href="https://airbyte.com">
<picture>
<source srcset="https://assets-global.website-files.com/605e01bc25f7e19a82e74788/621e2495cb90b8b2c3b31b0d_airbyte-octo-p-500.png">
<img alt="airbyte octavia" src="https://assets-global.website-files.com/605e01bc25f7e19a82e74788/621e2495cb90b8b2c3b31b0d_airbyte-octo-p-500.png" width="auto" height="150">
</picture>
</a>
</p>
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report...
Make sure you update this issue with a concise title and provide all information you have to
help us debug the problem together. Issues not following the template will be closed.
- type: input
id: cli-version
attributes:
label: Octavia CLI Version
description: Give the Octavia CLI version you're using.
validations:
required: true
- type: textarea
id: description
attributes:
label: Revelant information
description: Please give any additional information you have and steps to reproduce the problem.
- type: textarea
id: logs
attributes:
label: Relevant log output
description: |
Please copy and paste any relevant log output.
This will be automatically formatted into code, so no need for backticks.
We strongly recommend to upload the log file for further debugging.
render: shell

5
.github/ISSUE_TEMPLATE/feature-new-connector.yaml → .github/ISSUE_TEMPLATE/5-feature-new-connector.yaml vendored
View File

@@ -1,6 +1,5 @@
name: New Connector
description: Use this to request a new connector
title: "New Connector: <REMOVE THIS WITH THE CONNECTOR'S NAME>"
name: ✨ request a new connector
description: Request for new sources and destinations
labels: [area/connectors, new-connector]
body:
- type: input

20
.github/ISSUE_TEMPLATE/6-feature-request.yaml vendored Normal file
View File

@@ -0,0 +1,20 @@
name: ✨ request a new feature
description: Request to any new Airbyte features
labels: [type/enhancement, needs-triage]
body:
- type: dropdown
id: type
attributes:
label: What area the feature impact?
multiple: false
options:
- Connectors
- Airbyte Platform
- Helm Chart
- type: textarea
id: description
attributes:
label: Revelant Information
description: >-
What are you trying to do, and why is it hard? A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
A clear and concise description of what you want to see happen, or the change you would like to see

5
.github/ISSUE_TEMPLATE/low-code-component.yaml → .github/ISSUE_TEMPLATE/7-low-code-component.yaml vendored
View File

@@ -1,6 +1,5 @@
name: Low Code Component
description: Use this when requesting low-code CDK components
title: "Low-code CDK: <REMOVE WITH ISSUE TITLE>"
name: ✨ request a new low-code CDK component
description: Use this to request new low-code CDK
labels:
[
"team/extensibility",

16
.github/ISSUE_TEMPLATE/8-documentation.yaml vendored Normal file
View File

@@ -0,0 +1,16 @@
name: 📚 request or report a problem with documenation
description: For all docs typos, tutorials requests, etc.
labels: [type/enhancement, area/documentation needs-triage]
body:
- type: input
id: url
attributes:
label: Page URL
description: Paste the URL with problem when reporting an issue
placeholder: https://docs.airbyte.com/connector-development/connector-specification-reference
- type: textarea
id: description
attributes:
label: Description
description: >-
It can be as pedantic as a typo or as titanic as an entire tutorial request.

5
.github/ISSUE_TEMPLATE/other.yaml → .github/ISSUE_TEMPLATE/9-other.yaml vendored
View File

@@ -1,6 +1,5 @@
name: Others
description: Use this when the request doesn't fit other category.
title: "Other: "
name: 🤷 others issues requests...
description: Use this for whatever other issues you need to create but don't have a specific category.
labels: [needs-triage]
body:
- type: input

14
.github/ISSUE_TEMPLATE/documentation.md vendored
View File

@@ -1,14 +0,0 @@
---
name: Documentation request
about: Suggest an idea for new or updated documentation
title: ''
labels: type/enhancement, area/documentation
assignees: ''
---
### Tell us about the documentation you'd like us to add or update.
It can be as pedantic as a typo or as titanic as an entire tutorial request.
### If applicable, add links to the relevant docs that should be updated
- [Link to relevant docs page](https://docs.airbyte.io)

32
.github/ISSUE_TEMPLATE/feature-request.md vendored
View File

@@ -1,32 +0,0 @@
---
name: Feature request
about: Suggest an idea for Airbyte
title: ''
labels: type/enhancement, needs-triage
assignees: ''
---
## Tell us about the problem you're trying to solve
What are you trying to do, and why is it hard? A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
## Describe the solution you’d like
A clear and concise description of what you want to see happen, or the change you would like to see
## Describe the alternative you’ve considered or used
A clear and concise description of any alternative solutions or features you've considered or are using today.
## Additional context
Add any other context or screenshots about the feature request here.
## Are you willing to submit a PR?
<!---
We accept contributions!
Don't feel pressured, but if you want to contribute we can help you by giving some tips,
highlighting the necessary code change or explaining any relevant point your feature will impact.
You can also send questions on #dev Slack channel.
We understand if you can't submit a PR and we're tremendously grateful
that you've already contributed by suggesting a new feature.
-->
Remove this with your answer :-)

26
.github/ISSUE_TEMPLATE/issue-cli.yaml vendored
View File

@@ -1,26 +0,0 @@
name: CLI Issue
description: Use this when you're using the Octavia CLI.
title: "Octavia CLI Issue: <REMOVE WITH THE ISSUE TITLE>"
labels: [type/bug, area/octavia-cli, needs-triage]
body:
- type: input
id: cli-version
attributes:
label: Octavia CLI Version
description: Give the Octavia CLI version you're using.
validations:
required: true
- type: textarea
id: description
attributes:
label: Revelant information
description: Please give any aditional information you have your steps to reproduce the problem.
- type: textarea
id: logs
attributes:
label: Relevant log output
description: |
Please copy and paste any relevant log output.
This will be automatically formatted into code, so no need for backticks.
We strongly recommend to upload the log file to further debugging.
render: shell

58
.github/ISSUE_TEMPLATE/issue-connector.yaml vendored
View File

@@ -1,58 +0,0 @@
name: Connector Issue
description: Use this when you're facing issue with connector
title: "Connector Issue: <REMOVE WITH ISSUE TITLE>"
labels: [type/bug, area/connectors, needs-triage]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
Make sure you update the title with a concise title and provide all information you have to
help us debugging the problem together.
Issues not following the pattern will be closed.
- type: input
id: connector-name
attributes:
label: Connector Name
description: Give the connector name in form of airbyte/source-pokeapi, airbyte/destination-snowflake
validations:
required: true
- type: input
id: connector-version
attributes:
label: Connector Version
description: Give the connector version you're using. (eg. 0.2.63, 0.1.0)
validations:
required: true
- type: dropdown
id: step
attributes:
label: What step the error happened?
multiple: false
options:
- Configuring a new connector
- During the sync
- Updating the connector
- Other
- type: textarea
id: description
attributes:
label: Revelant information
description: Please give any aditional information you have your steps to reproduce the problem.
- type: textarea
id: logs
attributes:
label: Relevant log output
description: |
Please copy and paste any relevant log output.
This will be automatically formatted into code, so no need for backticks.
We strongly recommend to upload the log file to further debugging.
render: shell
- type: checkboxes
id: submit-pr
attributes:
label: Contribute
description: Are you willing to submit the fix?
options:
- label: Yes, I want to contribute
required: false

43
.github/ISSUE_TEMPLATE/issue-platform.yaml vendored
View File

@@ -1,43 +0,0 @@
name: Platform Issue
description: Use this when you're facing a platform, deploy or infrastructure issue.
title: "Platform Issue: <REMOVE WITH ISSUE TITLE>"
labels: [type/bug, area/platform, needs-triage]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
Make sure you update the title with a concise title and provide all information you have to
help us debugging the problem together.
Issues not following the pattern will be closed.
- type: input
id: platform-version
attributes:
label: Platform Version or Helm Chart Version
description: Give the Airbyte Platform version you're using. (eg. 0.44.1, 0.30.0)
validations:
required: true
- type: dropdown
id: step
attributes:
label: What step the error happened?
multiple: false
options:
- On deploy
- During the Sync
- Upgrading the Platform
- Other
- type: textarea
id: description
attributes:
label: Revelant information
description: Please give any aditional information you have your steps to reproduce the problem.
- type: textarea
id: logs
attributes:
label: Relevant log output
description: |
Please copy and paste any relevant log output.
This will be automatically formatted into code, so no need for backticks.
We strongly recommend to upload the log file to further debugging.
render: shell