2025-12-07 19:32:53 +02:00
|
|
|
# Contributing to OpenChamber
|
|
|
|
|
|
2025-12-21 16:21:10 +02:00
|
|
|
## Development
|
2025-12-07 19:32:53 +02:00
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
git clone https://github.com/btriapitsyn/openchamber.git
|
|
|
|
|
cd openchamber
|
2025-12-26 16:45:30 +02:00
|
|
|
bun install
|
2025-12-21 16:21:10 +02:00
|
|
|
|
|
|
|
|
# Web development
|
2025-12-26 16:45:30 +02:00
|
|
|
bun run dev:web:full
|
2025-12-21 16:21:10 +02:00
|
|
|
|
|
|
|
|
# Desktop app (Tauri)
|
2025-12-26 16:45:30 +02:00
|
|
|
bun run desktop:dev
|
2025-12-21 16:21:10 +02:00
|
|
|
|
|
|
|
|
# VS Code extension
|
2025-12-26 16:45:30 +02:00
|
|
|
bun run vscode:build && code --extensionDevelopmentPath="$(pwd)/packages/vscode"
|
2025-12-21 16:21:10 +02:00
|
|
|
|
|
|
|
|
# Production build
|
2025-12-26 16:45:30 +02:00
|
|
|
bun run build
|
2025-12-07 19:32:53 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Before Submitting
|
|
|
|
|
|
|
|
|
|
```bash
|
2025-12-26 16:45:30 +02:00
|
|
|
bun run type-check # Must pass
|
|
|
|
|
bun run lint # Must pass
|
|
|
|
|
bun run build # Must succeed
|
2025-12-07 19:32:53 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Code Style
|
|
|
|
|
|
|
|
|
|
- Functional React components only
|
|
|
|
|
- TypeScript strict mode - no `any` without justification
|
|
|
|
|
- Use existing theme colors/typography - don't add new ones
|
|
|
|
|
- Components must support light and dark themes
|
|
|
|
|
|
|
|
|
|
## Pull Requests
|
|
|
|
|
|
|
|
|
|
1. Fork and create a branch
|
|
|
|
|
2. Make changes
|
|
|
|
|
3. Run validation commands above
|
|
|
|
|
4. Submit PR with clear description of what and why
|
|
|
|
|
|
|
|
|
|
## Project Structure
|
|
|
|
|
|
|
|
|
|
See [AGENTS.md](./AGENTS.md) for detailed architecture reference.
|
|
|
|
|
|
|
|
|
|
## Questions?
|
|
|
|
|
|
|
|
|
|
Open an issue.
|
