Fix incorrect and outdated instructions in the README - #9
Merged
Conversation
- `rake spec` is not a task in this project; the test task is `test` - The EDITORS.md link 404s, the docs moved to shopify.github.io/ruby-lsp - Document `rake code_analysis` and the Ruby 3.0 minimum - Drop `rubocop` from the linter examples, since specifying it now logs a RuboCop 1.70 warning unrelated to this addon; explain it below instead - Note that pushing the tag now creates the GitHub release Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
RuboCop's `rubocop` vs `rubocop_internal` distinction is upstream's to document, not ours. The examples exist to show how to add reek alongside the linter most users already run. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.
Follow-up to #8. Each item below was verified against the repo or upstream rather than eyeballed.
Incorrect
rake specdoes not exist. TheRakefiledefinestestandcode_analysisonly, so the documented command fails withDon't know how to build task 'spec'. Nowbundle exec rake test.linters. The other four links in the README were checked and return 200.Outdated
rake code_analysiswas undocumented. Worth calling out since CI doesn't run it, so it relies on contributors remembering.releaseworkflow added in Create GitHub releases automatically on tag push #8.version.rbis given with its full path.Trivial
bundle gemboilerplate.The Usage section is deliberately untouched — the linter examples still show
[ "rubocop", "reek" ]. RuboCop'srubocopvsrubocop_internalsplit is upstream's nuance to document, not this gem's.Verified
bundle exec rake test(4 runs, 0 failures) andbundle exec rake code_analysis(0 warnings) both pass, since the README now tells contributors to run them.🤖 Generated with Claude Code