Skip to content

Contributing

Thank you for your interest in contributing to Booking Platform

Getting Started

1. Clone Repository

bash
git clone https://github.com/your-repo/booking-platform.git
cd booking-platform
bun install

2. Run Development Environment

bash
# Run all workspaces
bun run dev

# Run docs only
moon run apps-docs:dev

3. Create Branch

bash
git checkout -b feature/your-feature-name

Coding Guidelines

  • Use TypeScript for all files
  • Use Biome for lint and format
  • Use Conventional Commits for commit messages
  • Files must not exceed 250 lines
  • No TODO or MOCK in production code

Commit Messages

feat: add booking widget customization
fix: correct timezone in booking confirmation
docs: update API documentation for v2
refactor: split booking service into modules

Testing

bash
# Run all tests
bun run test

# Run lint
bun run lint

# Run typecheck
bun run typecheck

Submitting Pull Requests

  1. Create a new branch from main
  2. Write code following the guidelines
  3. Run bun run verify to pass
  4. Create a PR with a description
  5. Wait for review

Reporting Bugs

  1. Go to GitHub Issues
  2. Create a new issue
  3. Include:
    • Steps to reproduce the bug
    • Expected vs actual result
    • Environment (Browser, OS)
    • Screenshot (if available)

Proposing Features

  1. Create a GitHub Issue of type Feature Request
  2. Explain the use case and benefits
  3. Wait for discussion before implementing

Released under the MIT License.