Write a real README for herb-embedded (herb-embedded-xbi) - #46
Merged
Conversation
Replaces the one-line stub with a landing page aimed at a Rails dev deciding whether to adopt the gem: pitch, install/usage, the actual herb-lint-rb CLI flags, .herb.yml config, and custom rules — with a pointer to CHARTER.md for rationale instead of duplicating it. Co-Authored-By: Claude Sonnet 5 <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.
Summary
Replaces the one-line
# herb-embeddedstub with an actual README aimed at a Rails developer deciding whether to install the gem.Acceptance criteria (herb-embedded-xbi)
git:source (not yet on rubygems.org) plus a from-source build, and runningherb-lint-rb(including the no-directory-argument gotcha, verified againstRunner#files_for).lib/herb/embedded/cli.rb's actualOptionParserdefinitions..herb.ymlschema fromConfig/CLI::HERB_YML_TEMPLATE, plus a working.herb/rules/*.mjscustom-rule example (same shape as the one inspec/custom_rule_loader_spec.rb)..herb.ymlkeys, custom-rule loading behavior all verified directly; a couple of empirical smoke tests were run againstexe/herb-lint-rbto confirm documented CLI behavior matches reality).bundle exec rakepasses — rubocop clean, 100 examples / 0 failures.Test plan
bundle exec rake(rubocop + rspec) green--init,--version, and file-vs-directory argument behavior againstexe/herb-lint-rb🤖 Generated with Claude Code