Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Convert issue templates into forms #17855

Merged
merged 1 commit into from
Aug 27, 2021
Merged

Convert issue templates into forms #17855

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
129 changes: 129 additions & 0 deletions .github/ISSUE_TEMPLATE/airflow_bug_report.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
---
name: Airflow Bug report
description: Problems and issues with code of Apache Airflow core
labels: ["kind:bug", "area:core"]
body:
- type: markdown
attributes:
# yamllint disable rule:line-length
value: "
<img src='https://raw.githubusercontent.com/apache/airflow/main/docs/apache-airflow/img/logos/airflow_64x64_emoji_transparent.png' align='left' width='80' height='80'>
Thank you for finding the time to report the problem!

We really appreciate the community efforts to improve Airflow.

Note, that you do not need to create an issue if you have a change ready to submit!

You can open [Pull Request](https://github.com/apache/airflow/pulls) immediately instead.
<br clear='left'/>"
# yamllint enable rule:line-length
- type: dropdown
attributes:
label: Apache Airflow version
description: >
What Apache Airflow version are you using? Only Airflow 2 is supported for bugs. If you wish to
discuss Airflow 1.10, open [Discussion](https://github.com/apache/airflow/discussions) instead!
multiple: false
options:
- "2.1.3 (latest released)"
- "2.1.2"
- "2.1.1"
- "2.1.0"
- "2.0.2"
- "2.0.1"
- "2.0.0"
- "main (development)"
validations:
required: true
- type: input
attributes:
label: Operating System
description: What Operating System are you using?
placeholder: "You can get it via `cat /etc/os-release` for example"
validations:
required: true
- type: textarea
attributes:
label: Versions of Apache Airflow Providers
description: What Apache Airflow Providers versions are you using?
placeholder: You can use `pip freeze | grep apache-airflow-providers` (you can leave only relevant ones)
- type: dropdown
attributes:
label: Deployment
description: What kind of deployment do you have?
multiple: false
options:
- "Managed Services (Astronomer, Composer, MWAA etc.)"
- "Official Apache Airflow Helm Chart"
- "Other 3rd-party Helm chart"
- "Docker-Compose"
- "Other Docker-based deployment"
- "Virtualenv installation"
- "Other"
validations:
required: true
- type: textarea
attributes:
label: Deployment details
description: Additional description of your deployment.
placeholder: >
Enter any relevant details of your deployment. Especially version of your tools,
software (docker-compose, helm, k8s, etc.), any customisation and configuration you added.
- type: textarea
attributes:
label: What happened
description: Describe what happened.
placeholder: >
Please provide the context in which the problem occurred and explain what happened
- type: textarea
attributes:
label: What you expected to happen
description: What do you think went wrong?
placeholder: >
Please explain why you think the behaviour is erroneous. It is extremely helpful if you copy&paste
the fragment of logs showing the exact error messages or wrong behaviour and screenshots for
UI problems or YouTube link to a video of you demonstrating the problem. You can include files by
dragging and dropping them here.
- type: textarea
attributes:
label: How to reproduce
description: >
What should we do to reproduce the problem? If you are not able to provide a reproducible case,
please open a [Discussion](https://github.com/apache/airflow/discussions) instead.
placeholder: >
Please make sure you provide a reproducible step-by-step case of how to reproduce the problem
as minimally and precisely as possible. Keep in mind we do not have access to your cluster or DAGs.
Remember that non-reproducible issues will be closed! Opening a discussion is recommended as a
first step.
- type: textarea
attributes:
label: Anything else
description: Anything else we need to know?
placeholder: >
How often does this problem occur? (Once? Every time? Only when certain conditions are met?)
Any relevant logs to include? Put them here inside fenced
``` ``` blocks or inside a foldable details tag if it's long:
<details><summary>x.log</summary> lots of stuff </details>
- type: checkboxes
attributes:
label: Are you willing to submit PR?
description: >
This is absolutely not required, but we are happy to guide you in the contribution process
especially if you already have a good understanding of how to implement the fix.
Airflow is a community-managed project and we love to bring new contributors in.
Find us in #airflow-how-to-pr on Slack!
options:
- label: Yes I am willing to submit a PR!
- type: checkboxes
attributes:
label: Code of Conduct
description: The Code of Conduct helps create a safe space for everyone. We require
that everyone agrees to it.
options:
- label: >
I agree to follow this project's
[Code of Conduct](https://github.com/apache/airflow/blob/main/CODE_OF_CONDUCT.md)
required: true
- type: markdown
attributes:
value: "Thanks for completing our form!"
68 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE/airflow_doc_issue_report.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
name: Airflow Doc issue report
description: Problems and issues with docs of Apache Airflow
labels: ["kind:bug", "area:docs"]
body:
- type: markdown
attributes:
# yamllint disable rule:line-length
value: "
<img src='https://raw.githubusercontent.com/apache/airflow/main/docs/apache-airflow/img/logos/airflow_64x64_emoji_transparent.png' align='left' width='80' height='80'>
Thank you for finding the time to report the problem!

We really appreciate the community efforts to improve Airflow.

Note, that you do not need to create an issue if you have a change ready to submit!

You can open [Pull Request](https://github.com/apache/airflow/pulls) immediately instead.
<br clear='left'/>"
# yamllint enable rule:line-length
- type: textarea
attributes:
label: Describe the issue with documentation
description: Please describe the issue with documentation you have.
placeholder: >
Please include links to the documentation that has the problem and possibly screenshots showing
the problem. Explain why do you think it is an issue. Make sure you include view of the target
audience of the documentation. Please explain why you think the docs are wrong.
- type: textarea
attributes:
label: How to solve the problem
description: How do you think the problem can be solved?
placeholder: >
Please explain how you think the documentation could be fixed. Ideally specify where a new or missing
documentation should be added and what kind of information should be included. Sometimes people
writing the documentation do not realise that some assumptions the have might not be in the heads
of the reader, so try to explain exactly what you would like to see in the docs and why.
- type: textarea
attributes:
label: Anything else
description: Anything else we need to know?
placeholder: >
How often does this problem occur? (Once? Every time? Only when certain conditions are met?)
Any relevant logs to include? Put them here inside fenced
``` ``` blocks or inside a foldable details tag if it's long:
<details><summary>x.log</summary> lots of stuff </details>
- type: checkboxes
attributes:
label: Are you willing to submit PR?
description: >
This is absolutely not required, but we are happy to guide you in the contribution process
especially if you already have a good understanding of how to implement the fix.
Airflow is a community-managed project and we love to bring new contributors in.
Find us in #airflow-how-to-pr on Slack!
options:
- label: Yes I am willing to submit a PR!
- type: checkboxes
attributes:
label: Code of Conduct
description: The Code of Conduct helps create a safe space for everyone. We require
that everyone agrees to it.
options:
- label: >
I agree to follow this project's
[Code of Conduct](https://github.com/apache/airflow/blob/main/CODE_OF_CONDUCT.md)
required: true
- type: markdown
attributes:
value: "Thanks for completing our form!"
Loading