docs: add contributing guide - #9
Merged
Merged
Conversation
Documents the conventions a contributor cannot discover from the code: the exact CI gate list, the 100% coverage rule and test mirroring, the TSDoc/zero-dependency/strict-TS standards, when a changeset is needed (and when it is not), the PR flow, and the automatic release cycle.
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.
First draft of
CONTRIBUTING.md, kept small-library scale: only what a contributor cannot discover from the code, each claim verified against the repo.Sections
generate-text.tsas the named exemplar), the zero-runtime-dependency architectural rule, the strict-TS trio (noUncheckedIndexedAccess,exactOptionalPropertyTypes,verbatimModuleSyntax), ESM/named-exports/barrel conventionsDeliberately excluded: code of conduct, CLA, issue templates, generic advice — boilerplate that would rot.
No changeset attached (docs-only PR — per the guide's own policy 😉).