Skip to content

docs(contributing): add baseline contributing workflow and agnostic architecture guidelines#2

Open
k-dot-greyz wants to merge 1 commit into
mainfrom
docs/add-contributing-workflow
Open

docs(contributing): add baseline contributing workflow and agnostic architecture guidelines#2
k-dot-greyz wants to merge 1 commit into
mainfrom
docs/add-contributing-workflow

Conversation

@k-dot-greyz

@k-dot-greyz k-dot-greyz commented Jun 4, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds CONTRIBUTING.md with submodule boundary rules, GlitchWorks Agnostic Architecture Protocol, repository layout (current spec scaffold vs Phase 1 target from docs/MVP_SPEC.md), stack table, local quality gates, and fork-and-PR workflow.
  • Documents planned verification commands (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

  • Review CONTRIBUTING.md for accuracy against README.md and docs/MVP_SPEC.md
  • Confirm no monorepo-only workflow content was added to the submodule
  • After merge, link CONTRIBUTING.md from README.md if desired (optional follow-up)

Note

Low Risk
Documentation-only change with no runtime, security, or data-path impact.

Overview
Introduces CONTRIBUTING.md as the contributor-facing guide for lyrics-integrations, covering stack expectations, current vs Phase 1+ layout, and pointers to README.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:line events, edge validation, offline degradation), coding conventions, and local quality gates (git-only checks for spec-only trees; npm run check / npm test / npm run dev when 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.

@coderabbitai

coderabbitai Bot commented Jun 4, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@k-dot-greyz, we couldn't start this review because you've reached your PR review rate limit.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: da4a6e0c-0eae-4ae4-9bc1-64755b01bd16

📥 Commits

Reviewing files that changed from the base of the PR and between 3339fba and 53ff24a.

📒 Files selected for processing (1)
  • CONTRIBUTING.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/add-contributing-workflow

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant