Contributing

We welcome contributions to Oopsie! Here's how to get started.

Development setup

1. Fork and clone the repository
2. Start the development environment:

   docker compose up -d

3. The development override mounts your local files for hot-reloading

Project structure

/oopsie
├── server/      → Symfony API (PHP)
├── sdk/         → Vanilla JS/TS SDK
├── dashboard/   → Next.js admin dashboard
├── docs/        → Astro documentation site
└── .github/     → GitHub Actions workflows

Running tests

# Server
cd server && php bin/phpunit

# SDK
cd sdk && npm test

# Dashboard
cd dashboard && npm test

Guidelines

• All code, comments, and documentation must be in English
• PHP files must include declare(strict_types=1)
• Follow existing code conventions and patterns
• Write tests for new features
• Keep PRs focused and small

License

Oopsie is licensed under the AGPLv3. By contributing, you agree that your contributions will be licensed under the same license.