Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 779 Bytes

CONTRIBUTING.md

File metadata and controls

48 lines (32 loc) · 779 Bytes

Contributing

Thanks for contributing to Metapi.

Development Setup

  1. Install dependencies:
npm install
  1. Copy environment template:
cp .env.example .env
  1. Run migration and start development:
npm run db:migrate
npm run dev

Quality Checks

Run before opening a PR:

npm test
npm run build

Pull Request Guidelines

  • Keep PRs focused and small.
  • Add or update tests for behavior changes.
  • Update docs when user-facing behavior/config changes.
  • Avoid committing runtime data (data/) or temporary files (tmp/).

Commit Messages

Use concise messages with clear scope, for example:

  • feat: add token route health guard
  • fix: handle empty model list in dashboard
  • docs: clarify docker env setup