docs(contrib): add CONTRIBUTING.md#101
Merged
Merged
Conversation
Contributor onboarding written down. Covers: - Quick-start (clone, env setup, migrations, tests). - Pre-PR checklist: lint, test, audit, OpenAPI updates, CHANGELOG. - Commit-message conventions (conventional-commit prefixes, Co-Authored-By trailers for AI-assisted work). - What gets reviewed: auth scoping, zod input validation, soft- delete defaults, no raw SQL, logger discipline, tests. - What contributors DON'T need (no CLA, no specific IDE, etc.). - Where to start (good-first-issue label, test-file headers as the convention reference, CHANGELOG architectural rationale). Pairs with SECURITY.md (#100) to round out the open-source meta- documentation set. Co-Authored-By: Claude Opus 4.7 (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.
Summary
CONTRIBUTING.md so external contributors have a documented onboarding path. Covers quick-start, pre-PR checklist (lint/test/audit/OpenAPI/CHANGELOG), commit conventions, review focus areas, and where to start.
Pairs with SECURITY.md (#100) to round out the OSS meta-docs.
Test plan
This code proudly made in Nebraska. GO BIG RED! 🌽 https://xkcd.com/2347/