OpenSana Docs

Contributing Conventions

Follow the repo's code style, validation, and ownership conventions when contributing.

General Conventions

  • prefer early returns
  • use named exports
  • avoid any
  • avoid unsafe casts from untrusted input

Repo-Specific Conventions

  • use kebab-case file names outside convex/
  • use camelCase file names inside convex/
  • keep hooks near their owning domain
  • update tests for backend changes
  • run lint and type checks before finishing

Documentation Convention

If a change is user-visible:

  • update the relevant spec if needed
  • update public docs if the behavior affects users, admins, or contributors

On this page