Add a contributing guide - #28
Merged
Merged
Conversation
Documents what a contributor needs that was previously only discoverable by reading the workflow: which toolchain to install, how to run the tests, where the library classes end and the resources begin, and what the version job will check. Also explains the absence of ChefSpec, which otherwise reads as an oversight rather than a decision: the custom resources touch the real filesystem at converge time, so exercising them under ChefSpec would write to the host's own /etc/security/limits.conf. The file sits at the repository root rather than under .github because Supermarket's contributing_file quality metric matches /^contributing\.md$/i against the root listing only. chefignore already carries CONTRIBUTING*, so this stays out of the published cookbook artifact alongside TESTING.md and CHANGELOG.md.
jrwesolo
force-pushed
the
add-contributing-guide
branch
from
September 16, 2026 04:46
ef556dc to
afe562b
Compare
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.
Adds
CONTRIBUTING.md. There was no contributor documentation, so the setup, the test commands, and the conventions CI enforces were only discoverable by reading.github/workflows/ci.ymland the scripts next to it.What it covers
TESTING.mdfor the pinned versions rather than duplicating themlibraries/againstresources/, and which tests cover whichPlacement
The file is at the repository root rather than under
.github/. GitHub honours either for its own UI prompt, but Supermarket's quality metric does not:octokit_client.contents(repo)with no path lists the root only, so a file under.github/would fail the metric.Not in the published artifact
chefignorealready carriesCONTRIBUTING*, verified against the glob list directly:CONTRIBUTING.mdis excluded alongsideTESTING.mdandCHANGELOG.md, whileREADME.md,LICENSE,metadata.rb,libraries/andresources/still publish. The Supermarket metric reads the GitHub repository rather than the tarball, so excluding it costs nothing.Testing
Documentation only, no cookbook code changed.
cookstyle17 files no offenses,rspec66 examples 0 failures.Resource names and paths used as examples were checked against
resources/*.rband the tree rather than written from memory. Link references and code fences verified balanced and all resolving. Spelling follows the repository's existing US convention, matchingLICENSEandlicense 'MIT'inmetadata.rb.No version bump and no changelog entry, since nothing user-visible changed. This is the case the
versionjob is built to skip.