docs(contributing): add baseline contributing workflow and agnostic architecture guidelines#2
docs(contributing): add baseline contributing workflow and agnostic architecture guidelines#2k-dot-greyz wants to merge 1 commit into
Conversation
…rchitecture guidelines
|
Warning Review limit reached
More reviews will be available in 59 minutes and 50 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Summary
CONTRIBUTING.mdwith submodule boundary rules, GlitchWorks Agnostic Architecture Protocol, repository layout (current spec scaffold vs Phase 1 target fromdocs/MVP_SPEC.md), stack table, local quality gates, and fork-and-PR workflow.npm run check,npm test,npm run dev) for when the Vite/Vitest scaffold lands; spec-only checkouts use git audit steps only.Test plan
CONTRIBUTING.mdfor accuracy againstREADME.mdanddocs/MVP_SPEC.mdCONTRIBUTING.mdfromREADME.mdif desired (optional follow-up)Note
Low Risk
Documentation-only change with no runtime, security, or data-path impact.
Overview
Introduces
CONTRIBUTING.mdas the contributor-facing guide for lyrics-integrations, covering stack expectations, current vs Phase 1+ layout, and pointers toREADME.md/docs/MVP_SPEC.md.It codifies the submodule boundary (product code and docs only in-repo; monorepo SOPs stay in dev-master), the GlitchWorks Agnostic Architecture Protocol (config injection, interfaces,
lyrics:lineevents, edge validation, offline degradation), coding conventions, and local quality gates (git-only checks for spec-only trees;npm run check/npm test/npm run devwhen the scaffold exists). Also documents fork-and-PR steps, a pre-commit audit, and recovery if monorepo docs leak into the submodule.Reviewed by Cursor Bugbot for commit 53ff24a. Configure here.