You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by po...@apache.org on 2021/08/26 15:53:49 UTC
[airflow] branch form-in-issues created (now 029502d)
This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a change to branch form-in-issues
in repository https://gitbox.apache.org/repos/asf/airflow.git.
at 029502d Convert issue templates into forms
This branch includes the following new commits:
new 029502d Convert issue templates into forms
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[airflow] 01/01: Convert issue templates into forms
Posted by po...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a commit to branch form-in-issues
in repository https://gitbox.apache.org/repos/asf/airflow.git
commit 029502d412dac4a27a53fda5c894f9dbd61b7c26
Author: Jarek Potiuk <ja...@potiuk.com>
AuthorDate: Thu Aug 26 17:10:31 2021 +0200
Convert issue templates into forms
Following the discussion at
https://lists.apache.org/x/thread.html/r36d084d83cf7a66698c84185558e1bbe971c59533d4ac5d4994b0aca@%3Cdev.airflow.apache.org%3E
The issue templates are now Forms.
---
.github/ISSUE_TEMPLATE/bug_report.md | 66 -----------------
.github/ISSUE_TEMPLATE/bug_report.yml | 111 +++++++++++++++++++++++++++++
.github/ISSUE_TEMPLATE/feature_request.md | 42 -----------
.github/ISSUE_TEMPLATE/feature_request.yml | 43 +++++++++++
.github/ISSUE_TEMPLATE/~free_form.yml | 16 +++++
5 files changed, 170 insertions(+), 108 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 54972e5..0000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,66 +0,0 @@
----
-name: Bug report
-about: Problems and issues with code or docs
-title: ''
-labels: 'kind:bug'
-assignees: ''
-
----
-
-<!--
-Welcome to Apache Airflow!
-
-Please complete the next sections or the issue will be closed.
--->
-
-**Apache Airflow version**:
-
-<!-- AIRFLOW VERSION IS MANDATORY -->
-
-**OS**:
-
-<!-- MANDATORY! You can get it via `cat /etc/os-release` for example -->
-
-**Apache Airflow Provider versions**:
-
-<!-- You can use `pip freeze | grep apache-airflow-providers` (you can leave only relevant ones)-->
-
-**Deployment**:
-
-<!-- e.g. Virtualenv / VM / Docker-compose / K8S / Helm Chart / Managed Airflow Service -->
-
-<!-- Please include your deployment tools and versions: docker-compose, k8s, helm, etc -->
-
-**What happened**:
-
-<!-- Please include exact error messages if you can -->
-
-**What you expected to happen**:
-
-<!-- What do you think went wrong? -->
-
-**How to reproduce it**:
-
-<!--
-As minimally and precisely as possible. Keep in mind we do not have access to your cluster or dags.
-If this is a UI bug, please provide a screenshot of the bug or a link to a youtube video of the bug in action.
-You can include images/screen-casts etc. by drag-dropping the image here.
--->
-
-**Anything else we need to know**:
-
-<!--
-How often does this problem occur? Once? Every time etc?
-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>
--->
-
-**Are you willing to submit a PR?**
-
-<!---
-This is absolutely not required, but we are happy to guide you in 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!
- -->
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 0000000..af5440d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,111 @@
+---
+name: Bug Report
+description: Problems and issues with code or docs
+labels: ["kind:bug"]
+body:
+ - type: dropdown
+ attributes:
+ label: Apache Airlfow Version
+ description: What Apache Airflow version are you using?
+ multiple: false
+ options:
+ - "2.1.3 (latest)"
+ - "2.1.2"
+ - "2.1.1"
+ - "2.1.0"
+ - "2.0.2"
+ - "2.0.1"
+ - "2.0.0"
+ 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 Airlfow Providers
+ description: What Apache Airflow Provders 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 a context in which the problem occured and explain what happened!
+ - type: textarea
+ attributes:
+ label: What you expected to happen
+ description: What do you think went wrong?
+ placeholder: >
+ Please explain why do you think the behaviour is erronous. It is extremely helpful if you copy&paste
+ the fragment of logs showing the exact error messages or wrong behaviour and screenshots for the
+ UI problems or youtube link to video. You can include images/screen-casts etc. by drag-dropping the
+ image 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 [Discussion](https://github.com/apache/airflow/discussions) instead!
+ placeholder: >
+ Please makes 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.
+ Rember that non-reproducible issues will be closed! Often opening a discussion is better idea!
+ - type: textarea
+ attributes:
+ label: Anything else
+ description: Anything else we need to know?
+ placeholder: >
+ How often does this problem occur? Once? Every time etc?
+ 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 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 PR providing that I get guidance.
+ - 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!"
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
deleted file mode 100644
index a6cc116..0000000
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ /dev/null
@@ -1,42 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project or its docs
-title: ''
-labels: 'kind:feature'
-assignees: ''
-
----
-
-<!--
-
-Welcome to Apache Airflow! For a smooth issue process, try to answer the following questions.
-Don't worry if they're not all applicable; just try to include what you can :-)
-
-If you need to include code snippets or logs, please put them in fenced code
-blocks. If they're super-long, please use the details tag like
-<details><summary>super-long log</summary> lots of stuff </details>
-
-Please delete these comment blocks before submitting the issue.
-
--->
-
-**Description**
-
-<!-- A short description of your feature -->
-
-**Use case / motivation**
-
-<!-- What do you want to happen?
-
-Rather than telling us how you might implement this solution, try to take a
-step back and describe what you are trying to achieve.
-
--->
-
-**Are you willing to submit a PR?**
-
-<!--- We accept contributions! -->
-
-**Related Issues**
-
-<!-- Is there currently another issue associated with this? -->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 0000000..3a5b97a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,43 @@
+---
+name: Feature request
+description: Suggest an idea for this project or its docs
+labels: ["kind:feature"]
+body:
+ - type: textarea
+ attributes:
+ label: Description
+ description: A short description of your feature
+ - type: textarea
+ attributes:
+ label: Use case/motivation
+ description: What do you want to happen?
+ placeholder: >
+ Rather than telling us how you might implement this solution, try to take a
+ step back and describe what you are trying to achieve.
+ - type: textarea
+ attributes:
+ label: Related issues
+ description: Is there curently another issue asociated with this?
+ - type: checkboxes
+ attributes:
+ label: Are you willing to submit PR?
+ description: >
+ This is absolutely not required, but we are happy to guide you in 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 PR providing that I get guidance.
+ - 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!"
diff --git a/.github/ISSUE_TEMPLATE/~free_form.yml b/.github/ISSUE_TEMPLATE/~free_form.yml
new file mode 100644
index 0000000..1a5983d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/~free_form.yml
@@ -0,0 +1,16 @@
+---
+name: Task and Meta
+description: (Maintainers only) Tasks and Meta issues for the project
+labels: ["kind:meta"]
+body:
+ - type: textarea
+ attributes:
+ label: Body
+ description: Free form issue for committers to be able to add tasks/meta issues
+ - type: checkboxes
+ attributes:
+ label: Committer
+ description: Committer acknowledgment.
+ options:
+ - label: I acknowledge that I am a maintainer/committer of the Apache Airflow project.
+ required: true