docs: add OSS governance files and restructure documentation#29
Merged
Conversation
Design document covering: - README.md rewrite (consumer focus) - CONTRIBUTING.md (contributor workflow) - ARCHITECTURE.md (wrapper pattern deep-dive) - LICENSE, CODE_OF_CONDUCT.md, SECURITY.md (governance) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: Jared Scott <jared.scott@variable.team>
Detailed step-by-step plan for: - Task 1: Add LICENSE (copy from main Recce) - Task 2: Add CODE_OF_CONDUCT.md - Task 3: Add SECURITY.md - Task 4: Create ARCHITECTURE.md - Task 5: Create CONTRIBUTING.md - Task 6: Rewrite README.md - Task 7: Final verification 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: Jared Scott <jared.scott@variable.team>
Copy LICENSE from main Recce repository. Matches parent project licensing. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: Jared Scott <jared.scott@variable.team>
Contributor Covenant 2.0 code of conduct. Contact: conduct@reccehq.com Signed-off-by: Jared Scott <jared.scott@variable.team>
Security vulnerability reporting policy. Contact: security@reccehq.com 48-hour response commitment. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: Jared Scott <jared.scott@variable.team>
Deep-dive documentation covering: - Git submodule wrapper pattern - Build pipeline with tsdown - CSS aggregation strategy - Path alias system - Dependency management approach Signed-off-by: Jared Scott <jared.scott@variable.team>
Contributor guide covering: - Quick start (5 steps to dev environment) - Architecture overview with diagram - Development workflow (making changes, syncing, testing) - Commit conventions and PR process - Common issues and solutions 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: Jared Scott <jared.scott@variable.team>
Restructured README to focus on library consumers: - Added branding and badges - Added 'Looking to Contribute?' section - Streamlined quick start - Moved dev setup to CONTRIBUTING.md - Reduced from ~280 to ~140 lines Signed-off-by: Jared Scott <jared.scott@variable.team>
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
Adds standard open source governance files and restructures documentation for clear audience separation (consumers vs contributors).
Files Added
Files Modified
Documentation Structure
Test plan
pnpm buildpassespnpm type:checkpasses🤖 Generated with Claude Code