Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (29 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

42 lines (29 loc) · 1.35 KB

Contributing to Mixtape Engine

This repository houses proprietary code for the Mixtape workflow engine. Please keep all discussions and code reviews within approved internal channels.

Getting Started

npm install
npm run ci

All pull requests must be rebased on main (or develop when applicable) and pass npm run ci locally before opening a PR.

Branching Strategy

  • main: release-ready, tagged for publish.
  • develop: optional integration branch for upcoming releases.
  • Feature branches: feature/<short-description>.
  • Bugfix branches: fix/<short-description>.

Coding Standards

  • TypeScript targeting Node 18+.
  • No secrets, tokens, or customer data in the repo.
  • Keep LangGraph nodes and tools small and composable.
  • Update or add Vitest coverage when modifying behavior or state schemas.

Commit & PR Expectations

  1. Reference the ticket/issue ID in the branch or PR description.
  2. Document user-facing or API-impacting changes in the PR template.
  3. Add or update documentation when introducing new nodes, metrics, or prompts.
  4. Request review from @mixtapelabs/maintainers; at least one approval is required before merge.

Testing Checklist

  • npm run lint
  • npm run typecheck
  • npm test
  • npm run build

Use npm run ci to execute all checks in sequence. Do not merge unless every command passes locally and in CI.