You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2021/08/11 21:13:06 UTC
[GitHub] [airflow] potiuk opened a new pull request #17561: Simplify bug report template
potiuk opened a new pull request #17561:
URL: https://github.com/apache/airflow/pull/17561
By looking at several tens of issues recently I think I got a bit
better understanding on what people are actually reporting and
which information is really important - and I think the report
template might be vastly shortened, leaving only the important
parts:
* removed some comments that were repetitve and a bit too polite
(strenghtening the necessity of filling all details
* remove kernel. It's useless and default uname -a produced
some superfluous artifacts (Github recognising that as issues)
* comment stressing that Airflow version/OS is mandatory
* deployment is now a separate entry detailing all options
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst#pull-request-guidelines)** for more information.
In case of fundamental code change, Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in [UPDATING.md](https://github.com/apache/airflow/blob/main/UPDATING.md).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] jedcunningham commented on a change in pull request #17561: Simplify bug report template
Posted by GitBox <gi...@apache.org>.
jedcunningham commented on a change in pull request #17561:
URL: https://github.com/apache/airflow/pull/17561#discussion_r688103335
##########
File path: .github/ISSUE_TEMPLATE/bug_report.md
##########
@@ -8,89 +8,48 @@ 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.
-
--->
-
-<!--
-
-IMPORTANT!!!
-
-PLEASE CHECK "SIMILAR TO X EXISTING ISSUES" OPTION IF VISIBLE
-NEXT TO "SUBMIT NEW ISSUE" BUTTON!!!
-
-PLEASE CHECK IF THIS ISSUE HAS BEEN REPORTED PREVIOUSLY USING SEARCH!!!
+Welcome to Apache Airflow!
Please complete the next sections or the issue will be closed.
-These questions are the first thing we need to know to understand the context.
-
-->
**Apache Airflow version**:
-**Apache Airflow Provider versions** (please include all providers that are relevant to your bug):
+<!-- AIRFLOW VERSION IS MANDATORY -->
-<!--
+**OS**:
-You can get a complete list of your provider versions with `pip freeze | grep apache-airflow-providers`.
+<!-- MANDATORY! You can get it via `cat /etc/oss-release` for example -->
--->
+**Apache Airflow Provider versions**:
-**Kubernetes version (if you are using kubernetes)** (use `kubectl version`):
+<!-- You can use `pip freeze | grep apache-airflow-providers` (you can leave only relevant ones)-->
-**Environment**:
+**Deployment: Virtualenv/ VM / Docker-compose / K8S / Helm Chart / Managed Airflow Service**:
Review comment:
```suggestion
**Deployment**:
<!-- e.g. Virtualenv / VM / Docker-compose / K8S / Helm Chart / Managed Airflow Service -->
```
##########
File path: .github/ISSUE_TEMPLATE/bug_report.md
##########
@@ -8,89 +8,48 @@ 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.
-
--->
-
-<!--
-
-IMPORTANT!!!
-
-PLEASE CHECK "SIMILAR TO X EXISTING ISSUES" OPTION IF VISIBLE
-NEXT TO "SUBMIT NEW ISSUE" BUTTON!!!
-
-PLEASE CHECK IF THIS ISSUE HAS BEEN REPORTED PREVIOUSLY USING SEARCH!!!
+Welcome to Apache Airflow!
Please complete the next sections or the issue will be closed.
-These questions are the first thing we need to know to understand the context.
-
-->
**Apache Airflow version**:
-**Apache Airflow Provider versions** (please include all providers that are relevant to your bug):
+<!-- AIRFLOW VERSION IS MANDATORY -->
-<!--
+**OS**:
-You can get a complete list of your provider versions with `pip freeze | grep apache-airflow-providers`.
+<!-- MANDATORY! You can get it via `cat /etc/oss-release` for example -->
--->
+**Apache Airflow Provider versions**:
-**Kubernetes version (if you are using kubernetes)** (use `kubectl version`):
+<!-- You can use `pip freeze | grep apache-airflow-providers` (you can leave only relevant ones)-->
-**Environment**:
+**Deployment: Virtualenv/ VM / Docker-compose / K8S / Helm Chart / Managed Airflow Service**:
-- **Cloud provider or hardware configuration**:
-- **OS** (e.g. from /etc/os-release):
-- **Kernel** (e.g. `uname -a`):
-- **Install tools**:
-- **Others**:
+<!-- Please include version your deployment tools: docker-compose, k8s, helm, etc -->
Review comment:
```suggestion
<!-- Please include your deployment tools and versions: docker-compose, k8s, helm, etc -->
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] potiuk commented on pull request #17561: Simplify bug report template
Posted by GitBox <gi...@apache.org>.
potiuk commented on pull request #17561:
URL: https://github.com/apache/airflow/pull/17561#issuecomment-898050004
Applied comments :)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] potiuk commented on a change in pull request #17561: Simplify bug report template
Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #17561:
URL: https://github.com/apache/airflow/pull/17561#discussion_r688617891
##########
File path: .github/ISSUE_TEMPLATE/bug_report.md
##########
@@ -8,89 +8,58 @@ 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.
-
--->
-
-<!--
-
-IMPORTANT!!!
-
-PLEASE CHECK "SIMILAR TO X EXISTING ISSUES" OPTION IF VISIBLE
-NEXT TO "SUBMIT NEW ISSUE" BUTTON!!!
-
-PLEASE CHECK IF THIS ISSUE HAS BEEN REPORTED PREVIOUSLY USING SEARCH!!!
+Welcome to Apache Airflow!
Please complete the next sections or the issue will be closed.
-These questions are the first thing we need to know to understand the context.
-
-->
**Apache Airflow version**:
-**Apache Airflow Provider versions** (please include all providers that are relevant to your bug):
+<!-- AIRFLOW VERSION IS MANDATORY -->
-<!--
+**OS**:
Review comment:
Why? I actually deliberately replaced them, thinking that more often that not the problems will be connected with the OS than provider. When I think about an issue raised it's
`I am running Airflow on MacOS and I have those providers installed`. The "MacOS" is often much more important which providers are installed. I think providers are important in very small percentage of issues :)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] github-actions[bot] commented on pull request #17561: Simplify bug report template
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #17561:
URL: https://github.com/apache/airflow/pull/17561#issuecomment-898571019
The PR is likely ready to be merged. No tests are needed as no important environment files, nor python files were modified by it. However, committers might decide that full test matrix is needed and add the 'full tests needed' label. Then you should rebase it to the latest main or amend the last commit of the PR, and push it with --force-with-lease.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] jedcunningham commented on a change in pull request #17561: Simplify bug report template
Posted by GitBox <gi...@apache.org>.
jedcunningham commented on a change in pull request #17561:
URL: https://github.com/apache/airflow/pull/17561#discussion_r688627414
##########
File path: .github/ISSUE_TEMPLATE/bug_report.md
##########
@@ -8,89 +8,58 @@ 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.
-
--->
-
-<!--
-
-IMPORTANT!!!
-
-PLEASE CHECK "SIMILAR TO X EXISTING ISSUES" OPTION IF VISIBLE
-NEXT TO "SUBMIT NEW ISSUE" BUTTON!!!
-
-PLEASE CHECK IF THIS ISSUE HAS BEEN REPORTED PREVIOUSLY USING SEARCH!!!
+Welcome to Apache Airflow!
Please complete the next sections or the issue will be closed.
-These questions are the first thing we need to know to understand the context.
-
-->
**Apache Airflow version**:
-**Apache Airflow Provider versions** (please include all providers that are relevant to your bug):
+<!-- AIRFLOW VERSION IS MANDATORY -->
-<!--
+**OS**:
Review comment:
To me it makes sense to have airflow version info and os/deployment info grouped 🤷‍♂️. I'm not picky though.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] potiuk commented on pull request #17561: Simplify bug report template
Posted by GitBox <gi...@apache.org>.
potiuk commented on pull request #17561:
URL: https://github.com/apache/airflow/pull/17561#issuecomment-898047868
> LGTM. I wonder if we should add a “are you interested in submitting a PR to fix this” question like we do in the feature request template. I’ve been in many situations the reporter actually has the issue pretty much worked out and I only needed to ask that question to get a PR. It’d be nice to skip that step.
Crossed my mind to - we have similar question in "Feature request" and I was also wondering why not here, I thought it might be a little intimidating, and preventing people from raising an issue, but I think I can make it look good.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] jedcunningham commented on a change in pull request #17561: Simplify bug report template
Posted by GitBox <gi...@apache.org>.
jedcunningham commented on a change in pull request #17561:
URL: https://github.com/apache/airflow/pull/17561#discussion_r688529800
##########
File path: .github/ISSUE_TEMPLATE/bug_report.md
##########
@@ -8,89 +8,58 @@ 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.
-
--->
-
-<!--
-
-IMPORTANT!!!
-
-PLEASE CHECK "SIMILAR TO X EXISTING ISSUES" OPTION IF VISIBLE
-NEXT TO "SUBMIT NEW ISSUE" BUTTON!!!
-
-PLEASE CHECK IF THIS ISSUE HAS BEEN REPORTED PREVIOUSLY USING SEARCH!!!
+Welcome to Apache Airflow!
Please complete the next sections or the issue will be closed.
-These questions are the first thing we need to know to understand the context.
-
-->
**Apache Airflow version**:
-**Apache Airflow Provider versions** (please include all providers that are relevant to your bug):
+<!-- AIRFLOW VERSION IS MANDATORY -->
-<!--
+**OS**:
Review comment:
I think we should flip the order of OS and provider versions.
##########
File path: .github/ISSUE_TEMPLATE/bug_report.md
##########
@@ -8,89 +8,58 @@ 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.
-
--->
-
-<!--
-
-IMPORTANT!!!
-
-PLEASE CHECK "SIMILAR TO X EXISTING ISSUES" OPTION IF VISIBLE
-NEXT TO "SUBMIT NEW ISSUE" BUTTON!!!
-
-PLEASE CHECK IF THIS ISSUE HAS BEEN REPORTED PREVIOUSLY USING SEARCH!!!
+Welcome to Apache Airflow!
Please complete the next sections or the issue will be closed.
-These questions are the first thing we need to know to understand the context.
-
-->
**Apache Airflow version**:
-**Apache Airflow Provider versions** (please include all providers that are relevant to your bug):
+<!-- AIRFLOW VERSION IS MANDATORY -->
-<!--
+**OS**:
-You can get a complete list of your provider versions with `pip freeze | grep apache-airflow-providers`.
+<!-- MANDATORY! You can get it via `cat /etc/oss-release` for example -->
--->
+**Apache Airflow Provider versions**:
+
+<!-- You can use `pip freeze | grep apache-airflow-providers` (you can leave only relevant ones)-->
-**Kubernetes version (if you are using kubernetes)** (use `kubectl version`):
+**Deployment**:
-**Environment**:
+<!-- e.g. Virtualenv / VM / Docker-compose / K8S / Helm Chart / Managed Airflow Service -->
-- **Cloud provider or hardware configuration**:
-- **OS** (e.g. from /etc/os-release):
-- **Kernel** (e.g. `uname -a`):
-- **Install tools**:
-- **Others**:
+<!-- Please include your deployment tools and versions: docker-compose, k8s, helm, etc -->
**What happened**:
-<!-- (please include exact error messages if you can) -->
+<!-- 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 you are using kubernetes, please attempt to recreate the issue using minikube or kind.
-
-## Install minikube/kind
-
-- Minikube https://minikube.sigs.k8s.io/docs/start/
-- Kind https://kind.sigs.k8s.io/docs/user/quick-start/
-
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 using the .md style of
-
-
-To record a screencast, mac users can use QuickTime and then create an unlisted youtube video with the resulting .mov file.
-
---->
-
+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 in side a detail tag:
+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 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.
Review comment:
```suggestion
Airflow is a community-managed project and we love to bring new contributors in.
Find us in #airflow-how-to-pr on Slack!
```
##########
File path: .github/ISSUE_TEMPLATE/bug_report.md
##########
@@ -8,89 +8,58 @@ 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.
-
--->
-
-<!--
-
-IMPORTANT!!!
-
-PLEASE CHECK "SIMILAR TO X EXISTING ISSUES" OPTION IF VISIBLE
-NEXT TO "SUBMIT NEW ISSUE" BUTTON!!!
-
-PLEASE CHECK IF THIS ISSUE HAS BEEN REPORTED PREVIOUSLY USING SEARCH!!!
+Welcome to Apache Airflow!
Please complete the next sections or the issue will be closed.
-These questions are the first thing we need to know to understand the context.
-
-->
**Apache Airflow version**:
-**Apache Airflow Provider versions** (please include all providers that are relevant to your bug):
+<!-- AIRFLOW VERSION IS MANDATORY -->
-<!--
+**OS**:
-You can get a complete list of your provider versions with `pip freeze | grep apache-airflow-providers`.
+<!-- MANDATORY! You can get it via `cat /etc/oss-release` for example -->
--->
+**Apache Airflow Provider versions**:
+
+<!-- You can use `pip freeze | grep apache-airflow-providers` (you can leave only relevant ones)-->
-**Kubernetes version (if you are using kubernetes)** (use `kubectl version`):
+**Deployment**:
-**Environment**:
+<!-- e.g. Virtualenv / VM / Docker-compose / K8S / Helm Chart / Managed Airflow Service -->
-- **Cloud provider or hardware configuration**:
-- **OS** (e.g. from /etc/os-release):
-- **Kernel** (e.g. `uname -a`):
-- **Install tools**:
-- **Others**:
+<!-- Please include your deployment tools and versions: docker-compose, k8s, helm, etc -->
**What happened**:
-<!-- (please include exact error messages if you can) -->
+<!-- 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 you are using kubernetes, please attempt to recreate the issue using minikube or kind.
-
-## Install minikube/kind
-
-- Minikube https://minikube.sigs.k8s.io/docs/start/
-- Kind https://kind.sigs.k8s.io/docs/user/quick-start/
-
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 using the .md style of
-
-
-To record a screencast, mac users can use QuickTime and then create an unlisted youtube video with the resulting .mov file.
-
---->
-
+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 in side a detail tag:
+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 not required, but we are happy to guide you in contribution process
Review comment:
```suggestion
This is absolutely not required, but we are happy to guide you in contribution process
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] uranusjr commented on pull request #17561: Simplify bug report template
Posted by GitBox <gi...@apache.org>.
uranusjr commented on pull request #17561:
URL: https://github.com/apache/airflow/pull/17561#issuecomment-897880696
LGTM. I wonder if we should add a “are you interested in submitting a PR to fix this” question like we do in the feature request template. I’ve been in many situations the reporter actually has the issue pretty much worked out and I only needed to ask that question to get a PR. It’d be nice to skip that step.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] potiuk merged pull request #17561: Simplify bug report template
Posted by GitBox <gi...@apache.org>.
potiuk merged pull request #17561:
URL: https://github.com/apache/airflow/pull/17561
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org