Docs menuContributing
Docs/Operate

Contributing

Work on OpenNeko locally and keep docs, plugins, skills, and tests aligned.

Repository workflow

OpenNeko is a monorepo with the CLI, web app, worker, packages, database schema, built-in skills, plugin types, and compose assets. Make changes close to the package that owns the behavior and keep generated docs in sync with source behavior.

  • Use corepack and pnpm@9.14.1 for workspace commands; current CI and images are on Node 24.
  • The Go CLI module in apps/openneko targets Go 1.25.0.
  • Run migrations when schema changes touch packages/db.
  • Check skill packages with pnpm skills:check when you add or change SKILL.md content.
  • Prefer source-backed docs updates over marketing claims.

Testing

The exact test command depends on the package you touch. For docs-only changes in the website, run lint and build. For runtime changes, include the relevant package checks and exercise the CLI or worker path that owns the behavior.

Common checks
pnpm lint
pnpm build
pnpm skills:check