docs: bring CONTRIBUTING up to date and tidy dead config - #48
Merged
Conversation
CONTRIBUTING.md still described the repository as it was before the recent modernisation, and every specific in its tooling section had become false: it told contributors there were no unit tests, that the Rakefile depended on cane, tailor and countloc and would probably fail, that CI tested Ruby 2.5 to 3.0 against a master branch, and that the most valuable contribution would be porting the driver off SSHBase. All of that has since changed. It now describes the actual test suite and how it is organised, the real CI matrix, and the release process. The "most valuable contribution" section now asks for what the project genuinely needs: validation against a real CloudStack deployment, particularly the Windows and WinRM path, which is covered by stubbed tests but has never been run against real hardware. Also removes two pieces of dead configuration and tightens the gemspec: - .tailor configured a linter that was removed in #44. - .github/dependabot.yml duplicated Renovate, which is also enabled here and is what kitchen-ec2 settled on, so both bots were opening dependency pull requests. - The gemspec shipped everything git tracked, so the built gem carried the spec suite and the CI and linter dotfiles. It now ships the licence and lib, matching kitchen-ec2, which takes the packaged gem from 29 files to 7. - Adds metadata links so the RubyGems page points at the changelog, the source and the issue tracker. 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.
CONTRIBUTING.md was actively misleading
It described the repo as it was before #44 and #46, and every specific in its tooling section had become false:
SSHBasecane,tailor,countloc; "rakeis unlikely to succeed"rakeis the CI test taskmasterA contributor following it today would have been told not to bother running the tests.
It now documents the real suite (including how it's organised and why unit specs inject a fake client rather than stubbing
Fog::Computeglobally), the real CI matrix, and the release process.The "most valuable contribution" section now asks for what the project actually needs: validation against a real CloudStack deployment — particularly the Windows/WinRM path, which is covered by stubbed tests but has never touched real hardware. It also lists the driver gaps we know about (unwrapped provider errors, non-idempotent
create, no name→ID lookup) as good contributions.Dead config removed
.tailor— configured a linter removed in Require Ruby 3.1+ and modernize CI #44..github/dependabot.yml— duplicated Renovate, which is also enabled here (issue Dependency Dashboard #38 is its dashboard), so both bots were opening dependency PRs.kitchen-ec2settled on Renovate only; this matches.Gemspec
spec.fileswas rawgit ls-files, so the published gem shipped the spec suite and the CI/linter dotfiles. Now scoped toLICENSE|^libthe waykitchen-ec2does it:Also adds
spec.metadataso the RubyGems page links to the changelog, source, and issue tracker, and setsrubygems_mfa_required.Verified
rspec63/63 ·cookstyle --chefstyleclean ·yamllintclean ·markdownlintclean ·gem buildsucceeds · driver still loads🤖 Generated with Claude Code