Docs: clarify checkout-based development, Bundler usage, and test instructions - #144
Merged
Merged
Conversation
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
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.
Motivation
bundle installbehaves and that thepluginsgroup is optional so developers do not install unnecessary dependencies.bundle exec rake.Description
README.mdto add a "From a checkout" section that showsbundle exec bin/automatic --versionandbundle exec rake, explains thatbundle installresolves runtime and development dependencies fromGemfileandautomatic.gemspec, and notes thepluginsbundle group is not installed by default.doc/DEPLOYMENT.mdto soften the native-extension build tool guidance, addbundle exec raketo the checkout workflow, and explain default bundler behavior and optional plugin dependencies.doc/PLUGIN_DEVELOPMENT.mdto point plugin authors to the checkout setup inREADME.md(includingbundle installand running the default test suite).doc/QUICKSTART.mdto include a short "From a source checkout" path that references the README setup and usesbundle exec bin/automaticfor the same flow.vendor/entry as a legacy placeholder.Testing
bundle exec rakein a checkout, and the test suite completed successfully.spec/suite) were exercised as part of thebundle exec rakerun and passed.Codex Task