Contributing

Thanks for your interest in contributing to Draftila.

Before You Open a Pull Request

• Discuss significant changes in an issue first.
• Keep pull requests focused and small.
• Follow the existing project architecture and coding standards.

Code Style

Draftila enforces a consistent code style:

• No code comments — code must be self-documenting through clear naming and structure.
• Strict TypeScript — strict: true and noUncheckedIndexedAccess: true. No any.
• Prettier — single quotes, semicolons, trailing commas, 100 character print width.
• Unused variables — prefix with _.

API Conventions

• Module pattern: src/modules/{name}/{name}.routes.ts + {name}.service.ts. No controller layer.
• Routes handle HTTP concerns (parsing, validation, responses).
• Services handle business logic and database access.
• Validation — use Zod schemas from @draftila/shared. Return 400 with flattened errors on failure.
• Auth — use requireAuth middleware for protected routes.
• IDs — use nanoid() from src/common/lib/utils.ts.

Testing

• Tests live in apps/api/tests/, mirroring the src/ structure.
• Integration tests use app.request() — no server startup needed.
• Use helpers from tests/helpers.ts (cleanDatabase, createTestUser, getAuthHeaders).
• Call cleanDatabase() in beforeEach for test isolation.
• 100% line coverage is enforced on all API source files.

Frontend Conventions

• Use shadcn/ui components from src/components/ui/.
• State: Zustand for client state, TanStack Query for server state. No prop drilling.
• Use the @/* path alias for imports.
• Auth via better-auth React client.
• Forms use shadcn Form components with Zod validation.

Shared Package

License

Draftila is MIT licensed. By submitting a pull request, you confirm that:

• You have the right to submit your contribution.
• Your contribution is provided under this repository's MIT License.
• Your contribution remains available to the community under the same MIT terms.