🌱 enable godot on top-level comments

[sbueringer]

What this PR does / why we need it:

Goal of the PR in its current state is to discuss if we want to enable godot also on toplevel comments (default is declarations).

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

[sbueringer]

I think capitalization linting doesn't make sense as it has too many false positives.

The actual "trailing dot" part looks fine to me.

I would enable toplevel "trailing dot" linting but not capitalization.

    #   declarations - for top level declaration comments (default);
    #   toplevel     - for top level comments;
    #   all          - for all comments.
    scope: toplevel
    exclude:
    - '^ \+.*'
    - '^ ANCHOR.*'

WDYT?

P.S. We can test in a follow-up PR if all is an option (trailing dot findings: top-level : 32, all: 1950).

[fabriziopandini]

This goes in the direction of more consistency across the code base, so I'm +1

[stmcginnis]

I agree the punctuation is more useful than the capitalization.

It's probably OK to enable "all", but the only concern I would have with that is it's not obvious to new developers coming in that the linting will flag comments starting with the name of a privately scoped variable (lowercase) as an issue, so it could cause some frustration when linting checks fail. Not a huge deal, but something to consider.

[vincepri]

Do we need this? It seems flaky imo and lots of friction. The benefit of having a capital letter after a dot is small compared to a smoother new contributor experience

[sbueringer]

I would drop capitalization as stated in: #5591 (review)

Just wanted to wait for additional opinions.

Just didn't want to directly fix it to visualize how bad it is :)

[sbueringer]

Done

[sbueringer]

Dropped capitalization.

[fabriziopandini]

/lgtm

[killianmuldoon]

/lgtm

[vincepri]

/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vincepri

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [vincepri]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment