Automate a reminder to PR authors when their PR contains a large number of commits about website HOT 17 CLOSED

Alternative: we could offer training to new localization approvers.

from website.

This issue is currently awaiting triage.

SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the triage/accepted label.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

from website.

@seokho-son @a-mccarthy I've created this draft proposal to address the following items in the agenda for today's "SIG Docs Localization Subgroup Monthly Meeting":

The 903 commits in the upstream dev-1.24-bn.1 are not following the SIG-Docs commit squashing policy. dev-1.24-bn.1 contains too many redundant or irrelevant commits. My suggestion was to open another PR with one squashed commit for this first release of the Bengali localization. (#45009 (comment))
Reviewed how we've managed similar cases in the past: #45009 (comment)

You can close this issue if it duplicates others or seems impractical. I'm only putting it up here for discussion.

from website.

We would definitely need to enhance the message to something like:

This pull request contains more than 10 commits. To keep our commit history clean and manageable, please squash your commits before merging. If the detailed commit history is necessary for this PR, please communicate this in the PR description and request that the maintainer preserves it. Otherwise, maintainers are advised to use the 'Squash and merge' option when merging.

from website.

/sig contributor-experience

from website.

/sig testing

from website.

I'm not sure this would help. Most of the PRs that made dev-1.24-bn.1 have a high number of commits were not squashed (which I'd recommend), but for an anecdotal look, a large number of them had between 2 and 10 commits.

from website.

between 2 and 10 commits.

We can adjust the threshold number of commits in the script.
It's crucial to proactively train the localization approvers and promote their reliance on the documented guidelines relating to this issue: we can even link to the guideline in the body of the output comment.
This GitHub action serves the purpose of familiarizing or reiterating these guidelines to PR authors when needed.

from website.

I don't think a bot that only counts can help here @rolfedh. We can use something more sophisticated but commit count alone is a poor indicator of good practices being followed.

from website.

@sftim Agreed, then: no simple bot.
Would you say more about "something more sophisticated," please?
Let's solve the following issue:

The 903 commits in the upstream dev-1.24-bn.1 are not following the SIG-Docs commit squashing policy. dev-1.24-bn.1 contains too many redundant or irrelevant commits. My suggestion was to open another PR with one squashed commit for this first release of the Bengali localization. (#45009 (comment))
Reviewed how we've managed similar cases in the past: #45009 (comment)

from website.

My preference is still approver training. We shouldn't be working on a bot ahead of making sure that new approvers could also provide the same PR feedback manually.

from website.

I wasn't aware of a policy about squashing commits, although as a maintainer I will often suggest squashing. It's more of a convention.

from website.

Thanks for the conversation, @sftim. I think we can close this issue.
If anyone wants to propose an alternate solution, please open a new issue/enhancement request.

from website.

Bit of cleanup
/reopen

from website.

@sftim: Reopened this issue.

from website.

/close not-planned

from website.

@sftim: Closing this issue, marking it as "Not Planned".

from website.