[MINOR][INFRA] Add a guide to clarify release/unreleased Spark versions of user-facing change in the Github PR template#28403
Conversation
…ng change in the Github PR template
|
It sounds like non-minor thing which worths to initiate discussion. From my experience, first two sections have been ended up describing the similar things, hence many times I just mentioned that previous/next section covers it. I'm also wondering about the benefits of being strict about the section https://raw.githubusercontent.com/kubernetes/kubernetes/master/.github/PULL_REQUEST_TEMPLATE.md It would be mostly NONE, and require description only when the change worths to put into release note. I personally find the section useful to describe breaking backward compatibility, guide reviewers to focus more on the change, but if we need to put the information for any changes being shown to users (even doc) then it would become the huge pain. Have we gone through the PR template or contribution guide doc for similar size of open source projects? |
|
Oh there's another doc describing when to write release notes. At least it seems to be broader than I imagine, but still not sure the benefits of be strict about it. Shall we please have some reference PRs (best practice in k8s repo), and see what's missing here? |
|
Test build #122053 has finished for PR 28403 at commit
|
|
The benefit from this is to make it easier to track what caused a specific regression or behaviour change. Spark is being mature, and now it's getting more and more difficult to track the changes in the history. Also, note that this is rather a guidance than a strict requirement. I believe this doesn't block a PR. Well, this will likely be asked by a committer though. It actually makes the review/merge process faster. I myself happen to duplicate some contents time to time but I still see this is missing in other PR descriptions. I don't think the meaning vs k8s template is very different. We're just more conservative on the user-facing change - think about the Micheal's rubric of the amended semver as well. More importantly, what this PR proposes is just to guide contributors to know what to write there more explicitly and remove the ambiguity there. Changing the contents is orthogonal. |
|
retest this please |
|
Test build #122069 has finished for PR 28403 at commit
|
|
Thanks, merged to master. |
What changes were proposed in this pull request?
This PR proposes to add a guide to clarify the Spark version when describing "Does this PR introduce any user-facing change?".
Why are the changes needed?
It seems confusing to write when the user facing changes happen within unreleased branches.
Does this PR introduce any user-facing change?
No, dev-only.
How was this patch tested?
Manually tested in Github and it renders find as intended.