|
| 1 | +# Contributing to Waitless |
| 2 | + |
| 3 | +Thanks for your interest in contributing! Here's how to get started. |
| 4 | + |
| 5 | +## Development Setup |
| 6 | + |
| 7 | +### Prerequisites |
| 8 | +- Go 1.25+ |
| 9 | +- Bun 1.2+ |
| 10 | +- PostgreSQL 16+ |
| 11 | + |
| 12 | +### Quick Start |
| 13 | + |
| 14 | +```bash |
| 15 | +git clone https://github.com/waitless/waitless |
| 16 | +cd waitless |
| 17 | + |
| 18 | +# Configure |
| 19 | +cp .env.example .env |
| 20 | +# Edit .env with your local database credentials |
| 21 | + |
| 22 | +# Backend |
| 23 | +cd backend && go mod download |
| 24 | + |
| 25 | +# Frontend |
| 26 | +cd ../frontend && bun install |
| 27 | + |
| 28 | +# Run both dev servers |
| 29 | +make dev-backend # Terminal 1 |
| 30 | +make dev-frontend # Terminal 2 |
| 31 | +``` |
| 32 | + |
| 33 | +## Project Structure |
| 34 | + |
| 35 | +``` |
| 36 | +waitless/ |
| 37 | +├── backend/ # Go API server |
| 38 | +│ ├── cmd/server/ # Main entrypoint |
| 39 | +│ └── internal/ # Business logic |
| 40 | +│ ├── api/ # HTTP handlers |
| 41 | +│ ├── database/ # Database connection |
| 42 | +│ ├── middleware/ # Auth, security, rate limiting |
| 43 | +│ ├── models/ # GORM data models |
| 44 | +│ └── services/ # Email, crypto, validation |
| 45 | +├── frontend/ # TanStack Start + React |
| 46 | +│ └── src/ |
| 47 | +│ ├── routes/ # File-based routing |
| 48 | +│ └── lib/ # API client, utilities |
| 49 | +└── docker/ # Dockerfile + compose |
| 50 | +``` |
| 51 | + |
| 52 | +## Making Changes |
| 53 | + |
| 54 | +1. **Fork the repo** and create a branch from `main` |
| 55 | +2. **Write your code** — follow existing patterns |
| 56 | +3. **Test your changes** — `make test` |
| 57 | +4. **Submit a PR** — describe what you changed and why |
| 58 | + |
| 59 | +## Code Style |
| 60 | + |
| 61 | +- **Go**: `gofmt` + `go vet` |
| 62 | +- **TypeScript**: Standard TypeScript, no semicolons in JSX |
| 63 | +- **CSS**: Vanilla CSS with design tokens |
| 64 | + |
| 65 | +## What to Contribute |
| 66 | + |
| 67 | +- 🐛 Bug fixes |
| 68 | +- 📖 Documentation improvements |
| 69 | +- 🌐 Translations |
| 70 | +- 🧩 New integrations |
| 71 | +- ✅ Tests |
| 72 | +- 🎨 UI improvements |
| 73 | + |
| 74 | +## Reporting Issues |
| 75 | + |
| 76 | +Use GitHub Issues. Include: |
| 77 | +- Steps to reproduce |
| 78 | +- Expected vs actual behavior |
| 79 | +- Environment details (Go version, OS, browser) |
| 80 | + |
| 81 | +## License |
| 82 | + |
| 83 | +By contributing, you agree your contributions will be licensed under the MIT License. |
0 commit comments