Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (50 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

69 lines (50 loc) · 2.29 KB

Contributing to waha-tui

Thank you for your interest in contributing to waha-tui! 🎉

Quick Start

# Clone the repo
git clone https://github.com/muhammedaksam/waha-tui.git
cd waha-tui

# Install dependencies
bun install

# Run in development mode
bun run dev

Development Commands

Command Description
bun run dev Start in development mode
bun run build Build for production
bun run check Run all checks (typecheck, lint, format, test)
bun run test Run tests
bun run lint Run ESLint
bun run format Format code with Prettier
bun run migration:create <name> Create a new migration

Migrations

WAHA TUI uses a Sequelize-style migration system for config changes. Migrations run automatically on startup.

# Create a new migration
bun run migration:create my_migration_name

This creates src/utils/migrations/{timestamp}_my_migration_name.ts and registers it automatically.

Pull Request Process

  1. Fork the repository
  2. Create a feature branch from develop (git checkout -b feature/amazing-feature develop)
  3. Make your changes
  4. Run bun run check to ensure all tests pass
  5. Commit using Conventional Commits:
    • feat: New features
    • fix: Bug fixes
    • docs: Documentation changes
    • chore: Maintenance tasks
  6. Push to your fork
  7. Open a Pull Request targeting the develop branch

Code Style

  • TypeScript with strict mode
  • Prettier for formatting
  • ESLint for linting
  • No any types - use unknown instead

Security

If you discover a security vulnerability, please report it via the process outlined in SECURITY.md. Do not open public issues for security concerns.

Questions?

Open a GitHub Discussion or reach out in issues.