Put a proper warning on the ChefSpec page
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
We need to properly warn users to not use ChefSpec when it's not appropriate. A lot of users believe that they need to hit 100% code coverage for even the most trivial of cookbooks. This easily doubles the work involved in writing a Chef cookbook with near zero return in terms of maintainability. A section that outlined good uses of ChefSpec and bad uses of ChefSpec may be helpful here.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the ChefSpec page in the chef-web-docs repository and read its existing guidance. Add a clear warning about when ChefSpec is inappropriate, including good and bad use cases, and confirm that the page communicates why aiming for complete coverage may not be worthwhile for trivial cookbooks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100