Skip to content

Development Guide

Welcome to the Seed development guide! This section covers everything you need to contribute to Seed.

Development Workflow

Development Commands

Build and Run

bash
npm run build          # Compile TypeScript to dist/
npm run dev            # Development mode with hot reload
npm start              # Run compiled code

Testing

bash
npm test               # Run all tests once
npm run test:watch     # Run tests in watch mode
npm run test:coverage  # Generate coverage report

Code Quality

bash
npm run lint           # Lint source code
npm run typecheck      # Type check without emitting
npm run format         # Format code with Prettier
npm run format:check   # Check formatting
npm run validate       # Run all quality checks

Project Standards

  • TypeScript - Strict mode with ESM modules
  • Testing - Vitest with comprehensive coverage (42 config validation tests, 96.26% coverage)
  • Code Style - ESLint + Prettier
  • Commits - Clear, descriptive messages
  • Branches - feature/, fix/, docs/, refactor/ prefixes
  • Production Ready - ✅ Graceful shutdown, health checks, config validation, token revocation

Getting Help

  • Open an issue on GitLab
  • Check existing documentation
  • Review CONTRIBUTING.md

Released under the MIT License.