Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (40 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

57 lines (40 loc) · 1.65 KB
Raw

Contributing to @vllnt/convex-slugs

Thanks for your interest in contributing!

Development Setup

pnpm install
pnpm build
pnpm typecheck
pnpm lint
pnpm test:coverage

Use pnpm build:codegen only when you need to regenerate checked-in Convex _generated files and have access to the selected Convex project.

Testing

Tests use convex-test with the @edge-runtime/vm environment:

pnpm test           # single run
pnpm test:watch     # watch mode
pnpm test:coverage  # enforced 100% on covered files

Coverage is gated at 100% (vitest.config.mts). Every public method needs a happy-path test and at least one adversarial test (auth-denied, invalid input, boundary).

Code Style

  • Prettier + ESLint (run pnpm lint before submitting)
  • @vllnt/eslint-config/convex enforces: namespace separation, snake_case filenames, no bare v.any(), require returns validators, no N+1 queries
  • No any — use unknown + type guards
  • Explicit return types on public APIs
  • Mutations in mutations.ts, queries in queries.ts, validators in validators.ts

Pull Requests

  • Target main
  • One logical change per PR
  • Include tests for new behavior or bug fixes
  • Ensure all checks pass: pnpm typecheck && pnpm lint && pnpm test:coverage && pnpm build

Releases

Maintainers only:

  • Preferred: run .github/workflows/publish.yml via workflow_dispatch for patch/minor/major.
  • Local fallback: pnpm release (patch) / pnpm alpha (prerelease).

Reporting Issues

Use GitHub Issues. For security vulnerabilities, see SECURITY.md.