Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (56 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

68 lines (56 loc) · 1.88 KB

Contributing

Scope

This repository is an npm-workspaces monorepo:

  • sonus-react/ frontend
  • backend/ API
  • shared/ shared contracts

Product Identity

  • Sonus is a multilingual platform.
  • Keep user-facing copy language-aware (avoid single-language claims in root docs/UI unless a page is intentionally language-specific).
  • If your change affects product scope or positioning, update docs/PRODUCT_SCOPE.md.

Prerequisites

  • Node.js 20+
  • npm 10+
  • PostgreSQL (local or Docker) for backend integration checks

Setup

npm install
cp backend/.env.example backend/.env
npm --prefix backend run prisma:generate
npm --prefix backend run prisma:push

Local Development

npm run dev

Quality Gates (Required Before PR)

npm run lint
npm run build
npm test

Optional:

npm run quality:report:prod-safe
npm run codehealth

Pull Request Guidelines

  • Keep PRs focused and small where possible.
  • Include test evidence in the PR description.
  • Update docs when behavior, API, or operations change.
  • Do not commit secrets or .env files.
  • Avoid breaking mobile layouts and accessibility baselines.
  • Include before/after notes for routing, auth, and SRS logic changes (high-risk areas).

Engineering Standards

  • Prefer clear module boundaries over scattered conditionals.
  • Keep routing behavior predictable and environment-consistent.
  • Add tests for core decision logic (especially learning policy/SRS).
  • Fail safely: preserve backward compatibility where practical (for example, URL migration paths).
  • Do not mix unrelated refactors into feature or bug-fix PRs.

Commit Guidance

  • Use clear, imperative commit messages.
  • Group related file changes together.
  • Avoid mixing refactors with unrelated feature work.

Security

If you find a security issue, do not open a public issue first.
Use the process in SECURITY.md.