Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (28 loc) · 860 Bytes

CONTRIBUTING.md

File metadata and controls

40 lines (28 loc) · 860 Bytes

Contributing to WarpKit

Thank you for your interest in contributing to WarpKit!

Development Setup

  1. Clone the repository
  2. Install dependencies: bun install
  3. Run tests: bun test
  4. Type check: bun run typecheck

Code Style

  • Use TypeScript strict mode
  • Use Svelte 5 runes ($state, $derived, $effect)
  • Follow existing patterns in the codebase
  • Write tests for new functionality
  • Keep functions small and focused

Pull Request Process

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Run tests and type checking
  5. Submit a pull request

Commit Messages

Use clear, descriptive commit messages:

  • feat: for new features
  • fix: for bug fixes
  • docs: for documentation changes
  • test: for test changes
  • refactor: for refactoring

Questions?

Open an issue for questions or discussion.