Docs

Contributing to BetterAuth

Hello and welcome! We're thrilled that you're interested in contributing to Better Auth. Whether you're fixing bugs, adding new features, improving documentation, or just sharing ideas, your contribution helps make Better Auth better for everyone.

Getting Started

Before diving in, here are a few important resources:

Development Setup

To get started with development:

Make sure you have Node.JS installed, preferably on LTS.

1. Fork the repository

Visit https://github.com/better-auth/better-auth

Click the "Fork" button in the top right.

2. Clone your fork

# Replace YOUR-USERNAME with your GitHub username
git clone https://github.com/YOUR-USERNAME/better-auth.git
cd better-auth

3. Install dependencies

Make sure you have pnpm installed!

pnpm install

4. Prepare ENV files

Copy the example env file to create your new .env file.

cp -n ./docs/.env.example ./docs/.env

Making changes

Once you have an idea of what you want to contribute, you can start making changes. Here are some steps to get started:

1. Create a new branch

# Make sure you're on main
git checkout main
 
# Pull latest changes
git pull upstream main
 
# Create and switch to a new branch
git checkout -b feature/your-feature-name

2. Start development server

Start the development server:

pnpm dev

To start the docs server:

pnpm -F docs dev

3. Make Your Changes

  • Make your changes to the codebase.

  • Write tests if needed. (Read more about testing here)

  • Update documentation. (Read more about documenting here)

Best Practices

  • Write clear commit messages
  • Update documentation to reflect your changes
  • Add tests for new features
  • Follow our coding standards
  • Keep pull requests focused on a single change

Need Help?

Don't hesitate to ask for help! You can:

Together, we can make Better Auth an even better authentication solution. Thank you for being part of our community! Your contributions are greatly appreciated, and we look forward to collaborating with you!

FAQ

Frequently asked questions about Better Auth.

Areas To Contribute

Areas to contribute to BetterAuth

Edit on GitHub

On this page