Skip to content

Latest commit

 

History

History
62 lines (45 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

62 lines (45 loc) · 1.58 KB

Contributing to TypeZero

Thanks for your interest in contributing! 🎉

Before You Start

  1. Search existing issues and pull requests
  2. Open a new issue to discuss your proposal
  3. Share your thoughts and gather feedback
  4. Start coding and link the issue in your PR

Quick Start

  1. Fork and clone the repo
  2. Install dependencies: pnpm install
  3. Create a branch: git checkout -b feature/amazing-idea
  4. Make your changes
  5. Run tests: pnpm test
  6. Submit a PR

Commit Messages

  • Use clear and meaningful commit messages
  • Start with a verb (Add, Fix, Update, etc.)
  • Keep first line under 50 characters
  • Add details after a blank line if needed

Example:

Add TypeScript path aliases

- Configure tsconfig.json for @/ imports
- Update build process for alias support
- Add usage examples in README

Development

  • Run pnpm dev for development server
  • Follow existing code style
  • Check code quality with pnpm lint
  • Add tests for new features
  • Update documentation as needed

Pull Requests

  • Keep PRs focused on a single change
  • Add descriptive title and detailed description
  • Reference the original issue
  • Update tests and docs
  • Ensure all checks pass

Questions?

Open an issue or join our discussions for any questions.

Thanks for making TypeZero better! 🚀