Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Polish "Pluggable HTTP client" section in reference docs #1644

Merged
merged 1 commit into from
Apr 22, 2023

Conversation

izeye
Copy link
Contributor

@izeye izeye commented Apr 19, 2023

Description

This PR polishes the "Pluggable HTTP client" section in the reference docs a bit.

Before submitting a PR:

  • Changes must not break binary backwards compatibility. If you are unclear on how to make the change you think is needed while maintaining backward compatibility, CONTRIBUTING.md for details.
  • Add JavaDocs and other comments as appropriate. Consider including links in comments to relevant documentation on https://docs.github.com/en/rest .
  • Add tests that cover any added or changed code. This generally requires capturing snapshot test data. See CONTRIBUTING.md for details.
  • Run mvn -D enable-ci clean install site locally. If this command doesn't succeed, your change will not pass CI.
  • Push your changes to a branch other than main. You will create your PR from that branch.

When creating a PR:

  • Fill in the "Description" above with clear summary of the changes. This includes:
    • If this PR fixes one or more issues, include "Fixes #" lines for each issue.
    • Provide links to relevant documentation on https://docs.github.com/en/rest where possible.
  • All lines of new code should be covered by tests as reported by code coverage. Any lines that are not covered must have PR comments explaining why they cannot be covered. For example, "Reaching this particular exception is hard and is not a particular common scenario."
  • Enable "Allow edits from maintainers".

@codecov
Copy link

codecov bot commented Apr 22, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (77f7f81) 79.88% compared to head (d5974e9) 79.88%.

Additional details and impacted files
@@            Coverage Diff            @@
##               main    #1644   +/-   ##
=========================================
  Coverage     79.88%   79.88%           
  Complexity     2195     2195           
=========================================
  Files           209      209           
  Lines          6667     6667           
  Branches        364      364           
=========================================
  Hits           5326     5326           
  Misses         1127     1127           
  Partials        214      214           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@bitwiseman bitwiseman merged commit 5380f59 into hub4j:main Apr 22, 2023
@izeye izeye deleted the polish-20230419 branch April 23, 2023 00:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants