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/26 17:07:39 UTC

[GitHub] [airflow] uranusjr commented on a change in pull request #17855: Convert issue templates into forms

uranusjr commented on a change in pull request #17855:
URL: https://github.com/apache/airflow/pull/17855#discussion_r696822529



##########
File path: .github/ISSUE_TEMPLATE/bug_report.yml
##########
@@ -0,0 +1,114 @@
+---
+name: Bug report
+description: Problems and issues with code or docs
+labels: ["kind:bug"]
+body:
+  - 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)"
+        - "2.1.2"
+        - "2.1.1"
+        - "2.1.0"
+        - "2.0.2"
+        - "2.0.1"
+        - "2.0.0"
+        - "main"
+    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 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 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.
+        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>

Review comment:
       pip tried that and people tend to not know we already wrap the output in a code block and ```` ``` ```` the output themselves, resulting in broken markup. There’s not really a perfect UI for this, unfortunately, so I think the current method (telling users to wrap themselves) is better.




-- 
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