docs: Clarify nil http.Client usage has no timeout
#3910
+4
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a documentation comment to the
NewClientfunction ingithub/github.go.The comment warns users that passing a
nilhttpClientresults in the use of a defaulthttp.Clientwhich has no timeout. This can lead to resource exhaustion or "slowloris" style issues in production environments. It recommends providing a customhttp.Clientwith an appropriate timeout.This change aligns with security best practices (Sentinel) by making the default behavior's risks explicit without introducing breaking changes