Documentation

Build with Plavist

Plavist is open source. Self-host the stack, contribute features, or use the managed cloud when you want interviews that scale without losing the human plan.

Contributing

Small, reviewable PRs win. Match existing style. Never commit secrets. Prefer fixing an issue you claimed over speculative refactors.

Branch naming

feat/<short-description>     # new capability
fix/<short-description>      # bug fix
docs/<short-description>     # documentation only
chore/<short-description>    # tooling, deps, CI
refactor/<short-description> # no behavior change

Examples:
feat/interview-plan-export
fix/waitlist-email-check
docs/local-setup-redis

Workflow

  1. Fork the repo (client and/or server) and clone your fork.
  2. Create a branch from main using the naming scheme above.
  3. Make focused commits. Message style: feat: add X / fix: resolve Y.
  4. Push and open a PR against whoshriyansh/plavist_* main.
  5. Fill the PR template. Link the issue. Wait for CI + review.

What we merge

  • CI green (lint / typecheck / server smoke checks)
  • No secrets, credentials, or real .env values
  • Scoped diff — no drive-by formatting of unrelated files
  • Clear problem statement and test notes in the PR body
  • At least one maintainer approval

Security & secrets

Never push API keys, JWT secrets, GCP JSON keys, or production URLs with credentials. Use .env.example / env.example only. If you accidentally commit a secret, rotate it immediately and notify maintainers — do not rely on rewriting history alone.

Code of conduct

Be respectful. Harassment and personal attacks are not tolerated. See CODE_OF_CONDUCT.md in each repository.