Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (30 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

43 lines (30 loc) · 1.44 KB

Contributing to Mixtape API

This repository houses proprietary code for the Mixtape Express service. Please keep all discussions and 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: production-ready code deployed to primary environments.
  • 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 controllers small; push orchestration into services and repositories.
  • Update Vitest coverage and Supertest specs when modifying routes, middleware, or services.
  • Use Prisma migrations for any schema change.

Commit & PR Expectations

  1. Reference the ticket/issue ID in the branch or PR description.
  2. Document user-facing API changes in the PR template.
  3. Update README/Runbooks when introducing new endpoints, env vars, or dependencies.
  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.