Explore adding logging best-practices + logcheck to the Kubebuilder default scaffold or optional plugin for k8s conventions linter

[camilamacedo86]

Kubebuilder is used to build Kubernetes-native controllers, but logging guidance can be confusing for newcomers. Kubernetes logging conventions say log messages should start with a capital letter and not end with a period, while Go error strings should not be capitalised. This can lead to inconsistent logs in scaffolded projects.

Can we explore if Kubebuilder should:

1. Document the recommended pattern clearly (log message style vs error string style),
2. Ensure the default scaffold follows it,
3. Consider enabling or recommending the logcheck linter.

Links:

• K8s logging message style: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/logging.md#message-style-guidelines
• Go error strings: https://go.dev/wiki/CodeReviewComments#error-strings
• logcheck linter: https://github.com/kubernetes-sigs/logtools/tree/main/logcheck