Update boilerplate.go #18638
Update boilerplate.go #18638
Conversation
Preservation of Backward Compatibility: The existing codebase already relies on the -boilerplate-dir flag. Changing this flag name might break existing scripts or workflows that depend on it. Therefore, it's essential to keep this flag intact for backward compatibility. Adding a New Option: Introducing a new long option -root-dir provides flexibility and improves usability. Users who prefer long, descriptive option names can now use -root-dir instead of the potentially cryptic -boilerplate-dir. This makes the codebase more user-friendly without sacrificing existing functionality. Maintaining Short Option Consistency: To ensure consistency and compatibility with existing scripts or command-line interfaces, the short option -b (for -boilerplate-dir) remains unchanged. This consistency ensures that users accustomed to using short options can seamlessly transition to the new version without needing to update their scripts or commands. Overall, these changes aim to balance the need for introducing new features and improving usability while ensuring that existing users can continue using the tool without disruption.
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: r0cketdyne The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
cncf-cla: yes
|
Hi @r0cketdyne. Thanks for your PR. I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
k8s-ci-robot
added
the
size/M
|
Can one of the admins verify this patch? |
| return refs, nil | ||
| } | ||
|
|
||
| // filePasses checks whether the processed file is valid. Returning false means that the file does not the proper boilerplate template. |
There was a problem hiding this comment.
Why are we removing comments?
|
These specific comments seemed redundant.
…On Mon, Apr 15, 2024 at 11:29 PM Steven Powell ***@***.***> wrote:
***@***.**** requested changes on this pull request.
------------------------------
In hack/boilerplate/boilerplate.go
<#18638 (comment)>
:
> return refs, nil
}
-// filePasses checks whether the processed file is valid. Returning false means that the file does not the proper boilerplate template.
Why are we removing comments?
—
Reply to this email directly, view it on GitHub
<#18638 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/BFMUSBOTP6BJLLQBI3JWT6TY5Q2CHAVCNFSM6AAAAABGGDQQQSVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDAMBSGA4TEOJYGQ>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
Sure some are redundant, but some aren't, specifically: Also, isn't this PR just a duplicate of #18637? |
Preservation of Backward Compatibility: The existing codebase already relies on the -boilerplate-dir flag. Changing this flag name might break existing scripts or workflows that depend on it. Therefore, it's essential to keep this flag intact for backward compatibility.
Adding a New Option: Introducing a new long option -root-dir provides flexibility and improves usability. Users who prefer long, descriptive option names can now use -root-dir instead of the potentially cryptic -boilerplate-dir. This makes the codebase more user-friendly without sacrificing existing functionality.
Maintaining Short Option Consistency: To ensure consistency and compatibility with existing scripts or command-line interfaces, the short option -b (for -boilerplate-dir) remains unchanged. This consistency ensures that users accustomed to using short options can seamlessly transition to the new version without needing to update their scripts or commands.
Overall, these changes aim to balance the need for introducing new features and improving usability while ensuring that existing users can continue using the tool without disruption.