Simplify bug report template by making OS and Deployment optional#61285
Simplify bug report template by making OS and Deployment optional#61285Jgprog117 wants to merge 1 commit intoapache:mainfrom
Conversation
Reduces required fields in the bug report template to make it less intimidating for users to file bugs. The following fields are now optional instead of required: - Operating System - Deployment type This addresses concerns that too many required fields discourage users from reporting bugs, while still collecting critical information like Airflow version, bug description, and reproduction steps. Fixes apache#55840
|
Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
|
shahar1
left a comment
shahar1
left a comment
There was a problem hiding this comment.
Not against, but I think it needs some discussion in the Airflow's dev. list, especially as it reverts a past decision - feel free to open one.
| validations: | ||
| required: true |
There was a problem hiding this comment.
Not sure that I agree with making this optional, as sometimes the deployment method might give some good leads as for the root cause of an issue, or even the solution.
For example, in Cloud Composer they provide a list of dependencies for each version (including the providers):
https://docs.cloud.google.com/composer/docs/versions-packages#composer-3-airflow-3-1-0-build-7
Maybe we need to reorder/remove uncommon options though.
There was a problem hiding this comment.
I can understand the deployment info being useful for debugging, but I'd still like push back a bit. When someone has a CC issue, they're going to mention CC because that's their whole problem. The optional vs required distinction mostly affects people reporting core bugs where deployment doesn't matter.
If the worry is losing diagnostic info, maybe we could add help text explaining when these fields matter? Something like "especially important for deployment related issues"?
Happy to take the discussion to dev list if needed.
There was a problem hiding this comment.
I can understand the deployment info being useful for debugging, but I'd still like push back a bit. When someone has a CC issue, they're going to mention CC because that's their whole problem. The optional vs required distinction mostly affects people reporting core bugs where deployment doesn't matter.
If the worry is losing diagnostic info, maybe we could add help text explaining when these fields matter? Something like "especially important for deployment related issues"?
Happy to take the discussion to dev list if needed.
The thing with deployment, IMO, is that it could be related even for issues that allegedly it seems not :)
However, you got a point that it's not always like that - and I guess that over the gap between "simplifying the report process" and "not giving up on diagnostic info", I could live with making this optional in the cost of a better description (and again, maybe also with reordered/removed options).
Let's take the discussion to the dev list, I'll try to think in the meanwhile what else could be simplified.
|
@Jgprog117 This PR has been converted to draft because it does not yet meet our Pull Request quality criteria. Issues found:
What to do next:
Converting a PR to draft is not a rejection — it is an invitation to bring the PR up to the project's standards so that maintainer review time is spent productively. If you have questions, feel free to ask on the Airflow Slack. Note: This comment was drafted by an AI-assisted triage tool and may contain mistakes. Once you have addressed the points above, an Apache Airflow maintainer — a real person — will take the next look at your PR. We use this two-stage triage process so that our maintainers' limited time is spent where it matters most: the conversation with you. |
potiuk
added
the
closed because of multiple quality violations
|
This pull request has been converted to draft due to quality issues more than a week ago and there has been no response from the author. @Jgprog117, you are welcome to reopen this PR when you are ready to continue working on it. Thank you for your contribution! |
3 participants
Summary
Simplifies the bug report template by making Operating System and Deployment fields optional instead of required, addressing #55840.
Changes
Rationale
The current template requires 6 fields (Version, Description, Reproduction Steps, OS, Deployment, Code of Conduct), which can discourage users from filing bugs. This change reduces required fields to 4 while still collecting critical information:
Still Required:
Now Optional:
Optional fields can still be filled in when relevant, but users won't be blocked from submitting a bug report if they don't have all deployment details. This makes it easier for users to report bugs while maintaining the quality of submissions.
Fixes #55840