Skip to content
Better Auth RS

Contributing

Install devenv and direnv with its shell hook enabled. The repository’s .envrc activates the development environment automatically. Allow it once, then run the complete test gate:

Terminal window
direnv allow
devenv shell -- ./scripts/check.sh

You can also enter the environment manually with devenv shell. Rust tooling and lint rules come from the private cschmatzler/rust flake. Local development requires GitHub SSH access; CI uses the RUST_STYLE_TOKEN secret to fetch the locked revision. devenv.lock pins the environment.

See Tests for the unit, integration and compat tiers, and Compatibility testing for focused checks and the compatibility contract.

Documentation

Section titled “Documentation”

From the repository root:

Terminal window
pnpm install
pnpm docs:dev

Run pnpm docs:check for Astro diagnostics and pnpm docs:build for the static build and search index. Content lives in docs/src/content/docs; navigation is configured in docs/astro.config.mjs.

Keep explanations brief and show complete Rust setup, including plugin registration. Link to the official Better Auth docs for frontend usage. Check examples against this repository’s API and the pinned compatibility target, 1.7.6.