CONTRIBUTING.md

Contributing to Aura Stack Auth

Thank you for considering contributing to Aura Stack Auth! It's people like you that make this project such a great tool for the community.

Documentation

Visit the official contributing guide.

Getting Started

Clone your fork:

git clone https://github.com/YOUR_USERNAME/auth.git
cd auth

Install dependencies:

pnpm install

Build packages:

# Build all packages
pnpm build

# Build main packages only
pnpm build --filter=./packages/*

Development

Running the documentation server:

# Run all dev servers
pnpm dev

# Run docs only
pnpm dev:docs

# Alternative way to run docs
pnpm dev --filter=docs

Once started, open your browser at http://localhost:3000 to view the app.

Running test:

# Run tests
pnpm test

# Run tests with coverage
pnpm test:coverage

Formatting and style

# Type checking
pnpm type-check

# Format code
pnpm format

# Check formatting
pnpm format:check

Documentation

Visit the official documentation website.

License

Licensed under the MIT License. © Aura Stack

---

Made with ❤️ by Aura Stack team