Development Guide
This guide provides technical details for contributing to the codebase.
Git Workflow
Section titled “Git Workflow”Branch Naming
Section titled “Branch Naming”Use the following prefixes for your branches:
feature/: For new features (e.g.,feature/add-dark-mode)fix/: For bug fixes (e.g.,fix/mobile-nav-overlap)docs/: For documentation changes (e.g.,docs/update-readme)chore/: For maintenance tasks (e.g.,chore/upgrade-dependencies)
Commit Messages
Section titled “Commit Messages”We encourage (but don’t enforce) conventional commits:
feat: add new search componentfix: resolve sidebar scrolling issuedocs: update committee image guidelines
Testing Requirements
Section titled “Testing Requirements”We currently don’t have a comprehensive unit test suite, but we do require Build Verification.
pnpm buildIf the build fails locally, it will fail in production. Please fix all build errors before opening a PR.
Code Style
Section titled “Code Style”We use Prettier and ESLint to enforce a consistent code style.
Formatting
Section titled “Formatting”Format your code before committing:
pnpm formatType Checking
Section titled “Type Checking”Ensure there are no TypeScript errors:
pnpm check