WIP: Add developer hints #378
Conversation
By using ForConfigAndClient, we are more likely to reuse the http connection. We expose an HTTPClient, but also we default to the manager HTTPClient.
We've evolved a lot over time, and we could start nudging developers to use the now-recommended approaches and avoid the less-recommended approaches (without breaking compatability). Introduce a "hints" package that enables this.
k8s-ci-robot
added
the
do-not-merge/work-in-progress
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: justinsb 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:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
approved
|
PR needs rebase. 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. |
|
The Kubernetes project currently lacks enough contributors to adequately respond to all PRs. This bot triages PRs according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale |
k8s-ci-robot
added
the
lifecycle/stale
|
@justinsb a less hacky way to accomplish this would be to build a linter that can emit recommendations when obsolete methods are used - or to find one that already supports deprecation workflows and start annotating (or whatever mechanism that uses) APIs that now have better alternatives to support that. Then any developer using something like golangci-lint gets the hints without having to introduce new workflows or runtime panics... |
|
The Kubernetes project currently lacks enough active contributors to adequately respond to all PRs. This bot triages PRs according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle rotten |
k8s-ci-robot
added
lifecycle/rotten
|
The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs. This bot triages PRs according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /close |
|
@k8s-triage-robot: Closed this PR. In response to this:
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-sigs/prow repository. |
|
Hmm, I missed your suggestion @tomasaschan - reopening so I can try that. IIRC some of the things we probably want to detect are hard to detect statically. |
|
@justinsb: The following test failed, say
Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR. 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-sigs/prow repository. I understand the commands that are listed here. |
|
The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs. This bot triages PRs according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /close |
|
@k8s-triage-robot: Closed this PR. In response to this:
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-sigs/prow repository. |
WIP and distinct from #377 as I imagine we will want more discussion e.g. about testing / how to turn it off/on etc.
We've evolved a lot over time, and we could start nudging developers
to use the now-recommended approaches and avoid the less-recommended
approaches (without breaking compatability).
Introduce a "hints" package that enables us to output messages to developers to nudge them towards best practices.
(Builds on #377 as this is what made me think of this!)