Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (36 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

50 lines (36 loc) · 1.85 KB
Raw

Contributing

Thanks for helping improve @nuxtjs/better-auth.

Local setup

Use a supported Node.js version and enable the repository's pinned pnpm version:

corepack enable
pnpm install --frozen-lockfile
pnpm exec playwright-core install chromium

The integration suite needs Chromium. On Linux, use pnpm exec playwright-core install --with-deps chromium to install its system dependencies too, as CI does.

Run the module playground with pnpm dev, or the documentation site with pnpm dev:docs.

Before opening a pull request

Run the same core checks used by CI. The playground build requires an auth secret. The example below uses CI's test secret for local verification only; do not use it for a deployed application.

pnpm lint
pnpm typecheck
pnpm typecheck:runtime-server
pnpm typecheck:playground
pnpm prepack
pnpm test
pnpm test:runtime
BETTER_AUTH_SECRET=ci-test-secret-12345678901234567890 pnpm dev:build
pnpm build:docs

pnpm test builds the package during test setup and can take several minutes. Nuxt runtime tests run separately with pnpm test:runtime. During development, run the narrowest relevant Vitest project first, for example:

pnpm vitest run test/get-request-session.test.ts --project unit
pnpm vitest run test/module.test.ts --project integration

Some integration fixtures update their local .nuxtrc setup version during a run. Do not include those generated changes unless your pull request intentionally changes the fixture.

Pull requests

  • Keep each pull request focused on one behavior or maintenance concern.
  • Add a regression test for bug fixes and public contract changes.
  • Update user documentation when behavior or configuration changes.
  • Describe the user-visible impact and list the checks you ran.
  • Do not commit secrets, generated .nuxt output, build artifacts, or local environment files.