মেইনটেইনার প্লেবুক
গাইডস ইনডেক্স
Operational playbook এবং suggested reading order-এর এন্ট্রি পয়েন্ট।
২ মিনিট পড়া
Guides Index
Purpose
This is the starting point for maintainers, contributors, and team members who work with this boilerplate. Each guide covers a specific operational area — from shipping your first deployment to keeping the project healthy over the long term.
Think of this as your **operations playbook**. You don't need to read everything at once — pick the guide that matches what you're trying to do right now.
Guide Map
| Guide | What It Covers | Who It's For |
|---|---|---|
| [Adopting This Boilerplate](adopting-boilerplate.md) | What to rename, configure, replace, remove, and verify when starting a real project from this template | Product teams and developers creating a new app |
| [Contributing Guide](contributing.md) | PR rules, commit conventions, dev setup, testing guidelines | Contributors and new team members |
| [Auth Setup and Migration](auth-setup-and-migration.md) | Configure better-auth for production or switch to custom-auth | Maintainers and teams preparing staging/production |
| [Database Setup](database-setup.md) | PostgreSQL, Neon, Drizzle migrations, runtime DB access, and production migration workflow | Developers configuring data infrastructure |
| [Deployment Guide](deployment.md) | End-to-end deployment: pre-checks, build validation, database migration, provider setup, and post-deploy verification | Anyone deploying to production or staging |
| [Production Services](production-services.md) | Sentry, Resend, Upstash Redis, and production migration secrets | Maintainers preparing a public production launch |
| [GitHub Setup Checklist](github-setup-checklist.md) | Branch protection, required CI checks, secrets management, labels, and release permissions | Repository admins and team leads setting up a new repo |
| [Project Maintenance](project-maintenance.md) | Daily, weekly, monthly, and quarterly routines to keep the project stable and secure | Active maintainers and regular contributors |
| [Release Automation](release-automation.md) | How Release Please works, conventional commit rules, version bumps, and troubleshooting | Anyone involved in the release process |
Recommended Reading Order
If you're new to this boilerplate, follow this order:
- **Adopt the template** → [Adopting This Boilerplate](adopting-boilerplate.md)
- **Learn how to contribute** → [Contributing Guide](contributing.md)
- **Pick your auth path** → [Auth Setup and Migration](auth-setup-and-migration.md)
- **Configure the database** → [Database Setup](database-setup.md)
- **Set up your repo** → [GitHub Setup Checklist](github-setup-checklist.md)
- **Configure production services** → [Production Services](production-services.md)
- **Ship to production** → [Deployment Guide](deployment.md)
- **Understand releases** → [Release Automation](release-automation.md)
- **Keep things healthy** → [Project Maintenance](project-maintenance.md)
Related Docs
- [Security](../security.md) — Defense-in-depth architecture covering 18 attack types, CSP, CSRF, rate limiting, and customization
- [Architecture](../architecture.md) — System layers and design decisions
- [Auth Flow](../auth-flow.md) — Authentication lifecycle and security controls
- [How to Use](../how-to-use.md) — First-time setup and daily workflow
- [Workflows](../workflows.md) — CI/CD automation overview
Current Repository Policies (Important)
- Documentation source policy: markdown article content is maintained in English source files.
- UI language toggle can still change interface copy (labels/navigation), but article source content is intentionally unified.
- Dependency auto-merge is guarded by policy (patch-only + ecosystem/dependency filters + denylist for core packages).
- Release notes include enriched metadata and contributor cards generated by workflow automation.