Repository navigation
docs: rewrite the readme and add a contributing guide - #17
Merged
Merged
Conversation
The README was a mix of usage docs and a generic fork-and-branch section, with links still pointing at pre-transfer repositories and `master`. It is now just what a user of the plugin needs: what it does, what it requires, where tests go, and what a passing test looks like. Everything a contributor needs moved to a new CONTRIBUTING.md, modelled on the one in test-kitchen/busser -- how to set the project up, how to run the suite, the linters CI runs, and the Conventional Commits convention release-please reads. Every development dependency now carries a version floor at its current major, so a resolver cannot quietly pick an ancient release: cookstyle 9, aruba 2.4, cucumber 11.1, rake 13.4, simplecov 1.1. Test tooling brought up to date: * `.rubocop.yml` targeted Ruby 3.1 while the gemspec requires 3.2. * The `After` hook setting `Cucumber.wants_to_quit` is replaced by cucumber's own `--fail-fast`, which is the supported way to stop at the first failure. * `-x` (`--expand`) is dropped; it only affects Scenario Outline output and there are no outlines here. `.simplecov` is removed: SimpleCov auto-loads it on require and started a "gem" profile there, while env.rb separately set a command name, so which profile applied depended on load order. The whole thing is now in env.rb behind COVERAGE. The dead `@aruba_timeout_seconds` Before hook is also replaced here. aruba 2 removed it, so it was a no-op and commands ran on aruba's 15 second default; the sibling plugins already got this fix. Signed-off-by: Tim Smith <tsmith84@proton.me>
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.
The README was a mix of usage docs and a generic fork-and-branch section, with
links still pointing at pre-transfer repositories and
master. It is now justwhat a user of the plugin needs: what it does, what it requires, where tests go,
and what a passing test looks like. Everything a contributor needs moved to a
new CONTRIBUTING.md, modelled on the one in test-kitchen/busser -- how to set the
project up, how to run the suite, the linters CI runs, and the Conventional
Commits convention release-please reads.
Every development dependency now carries a version floor at its current major,
so a resolver cannot quietly pick an ancient release: cookstyle 9, aruba 2.4,
cucumber 11.1, rake 13.4, simplecov 1.1.
Test tooling brought up to date:
.rubocop.ymltargeted Ruby 3.1 while the gemspec requires 3.2.Afterhook settingCucumber.wants_to_quitis replaced by cucumber'sown
--fail-fast, which is the supported way to stop at the first failure.-x(--expand) is dropped; it only affects Scenario Outline output andthere are no outlines here.
.simplecovis removed: SimpleCov auto-loads it on require and started a "gem"profile there, while env.rb separately set a command name, so which profile
applied depended on load order. The whole thing is now in env.rb behind
COVERAGE.
The dead
@aruba_timeout_secondsBefore hook is also replaced here. aruba 2removed it, so it was a no-op and commands ran on aruba's 15 second default;
the sibling plugins already got this fix in their modernization pull requests.