Repository navigation
Polish README against rubygem README rubric - #2
Merged
Merged
Conversation
Apply review findings against the authoring-rubygem-readmes rubric: synopsis states mechanism instead of marketing, install shows Gemfile form first, Quick start documents the return value, custom channel example uses keyword args and real Net::HTTP, Sidekiq example annotates PageLoadError#report, and the file gains Documentation, Contributing, Code of Conduct, and Supported Ruby versions sections. License now links LICENSE.txt.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
# => nilreturn and DeliveryError semantics.Slack.new(webhook_url:)and a runnableNet::HTTPcall instead of pseudocode.PageLoadError#reportcarries the partial report.LICENSE.txt.Test plan
ruby -cof the snippet).