[SPARK-55597][INFRA] Add initial issue templates for spark#54374
[SPARK-55597][INFRA] Add initial issue templates for spark#54374gaogaotiantian wants to merge 8 commits intoapache:masterfrom
Conversation
|
@dongjoon-hyun and @HyukjinKwon , let me know if you have other ideas about the templates. I think we should have something simple as a start then gradually make it better from feedbacks. There's also a chance that github issues is not used a lot and we shouldn't put too much effort into it. Let's prepare it in a state that users feel comfortable using it and see if we can improve it in the future. |
.github/ISSUE_TEMPLATE/bug.yml
Outdated
| - "Spark Submit" | ||
| - "SparkR" | ||
| - "SQL" | ||
| - "SS" |
There was a problem hiding this comment.
SS is Structured Streaming so could be removed
.github/ISSUE_TEMPLATE/bug.yml
Outdated
| - "Pandas API on Spark" | ||
| - "Project Infra" | ||
| - "Protobuf" | ||
| - "PS" |
.github/ISSUE_TEMPLATE/bug.yml
Outdated
| - "Block Manager" | ||
| - "Build" | ||
| - "Connect" | ||
| - "Connect Contrib" |
There was a problem hiding this comment.
I would just have one "Connect" and remove this
.github/ISSUE_TEMPLATE/bug.yml
Outdated
| - "Input/Output" | ||
| - "Java API" | ||
| - "Kubernetes" | ||
| - "Mesos" |
There was a problem hiding this comment.
Mesos is officially deprecated and removed.
.github/ISSUE_TEMPLATE/bug.yml
Outdated
| - "Optimizer" | ||
| - "Pandas API on Spark" | ||
| - "Project Infra" | ||
| - "Protobuf" |
There was a problem hiding this comment.
I would remove this. I think it refers to protobuf functions we added but it's not really worthwhile as a separate component
.github/ISSUE_TEMPLATE/bug.yml
Outdated
| - "Protobuf" | ||
| - "PS" | ||
| - "PySpark" | ||
| - "R" |
|
The comments are incredibly useful because I'm not that familiar with all the components in spark. I just copied the list from JIRA. It would be nice if we can have a concise list of important components. Just removed all the duplicated ones. |
| @@ -0,0 +1,51 @@ | |||
| name: Enhancement | |||
There was a problem hiding this comment.
Please use Improvement like Apache Spark JIRA Issue Type instead of breaking the convention.
There was a problem hiding this comment.
I named this intentionally so it includes both "improvement" and "new feature". Do we want two templates for "improvement" and "new feature"? The reason I ask is because these two templates might be very similar as the nature of "improvement" and "new feature" is pretty close.
I did a quick search before I started working on this template, both inside and outside of apache. I did not find any project that has both "improvement" and "new feature" in their templates.
An alternative way to make this a 1 on 1 match with JIRA is to have a template named "new feature or improvement". Then we have a required drop down for user to select whether they want a new feature or improvement. The rest of the template would be the same between those two. In the future if we need to create a JIRA based on github issue, we can refer to this option.
There was a problem hiding this comment.
I'd like to start with Improvement only because this is an experimental channel. Please don't invent a new one here, @gaogaotiantian .
I named this intentionally
There was a problem hiding this comment.
According to our discussion, new GitHub Issues feature is supposed to work harmoniously with the existing convention instead of creating new confusion without a community consensus. Please don't make a new concept here based on your personal idea.
There was a problem hiding this comment.
Sure, then we need to rename the label Type: Enhancement to Type: Improvement so it can be linked correctly. I will update this issue template.
|
@dongjoon-hyun I updated both the spark version for bug report and the naming of improvement template. The only thing I can't do is to rename the label - https://github.com/apache/spark/labels?q=type this requires access to the repository. After we rename |
Added licensing information to the bug report template.
Added licensing information and updated template details.
|
Thank you for informing that. I updated it to help your activity.
|
|
shall we consider using the builtin "issue type" instead of labels? 
|
|
I think issue type is an organizational level configuration which means asf needs to come up with a set of types for us to use. That might be too much an overhead. |
|
This PR should be ready to merge. Then we can test if it works properly. |
4 participants
What changes were proposed in this pull request?
Add issue templates for spark.
Why are the changes needed?
We should provide a template for community about what we need from them. This is not a comprehensive format but it's a start. We can incrementally make it better while working with it.
The labels for bug and enhancement are already created. The reason I did not separate "improvement" and "feature" is because they are very similar concepts. A new feature can be an improvement to spark. The template would be very similar and a bit confusing to community. If we do need to distinguish them in the future, we can add a drop down menu in the template so it matches JIRA perfectly.
Does this PR introduce any user-facing change?
No.
How was this patch tested?
Not code.
Was this patch authored or co-authored using generative AI tooling?
No.