Repository navigation
docs: adopt unified CONTRIBUTING.md standard - #66
Merged
Merged
Conversation
Replace CONTRIBUTING.md with the shared library standard and move repo-specific coverage floors and bundle-size budget notes into README.md. Refs #65
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
2 participants
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.
Closes #65
What
Replaces CONTRIBUTING.md with the byte-for-byte shared library standard (
/Users/bhouston/Coding/standards/CONTRIBUTING.library.md). Moves the repo-specific coverage-floor and bundle-size-budget notes from the old CONTRIBUTING.md into README.md's Development section.Why
Standardize contributing docs across bhouston OSS repos.
Validation
pnpm install --frozen-lockfilepnpm exec oxfmt --check CONTRIBUTING.md README.mdpnpm tsc) on commit and passedcontributionjob already runsscripts/check-pr.mjs+ commitlint on the PR title and commit range, so the new CONTRIBUTING.md's claims about CI are already true