Quick Start¶
Get up to speed as a core contributor in a few minutes.
1. Start the dev environment¶
git clone https://github.com/xuedi/meetAgain.git && cd meetAgain
just devModeFixtures
# Open https://meetagain.local — admin@example.org / 1234
See Getting Started for the full setup (local hostname, Docker prerequisites, etc.).
2. Understand the layer rule¶
Dependencies flow downward only. Never call a service from a repository; never put business logic in a controller. See Architecture for the full rules.
3. Find the right file¶
| If you're changing… | Start in… |
|---|---|
| Business logic | src/Service/ |
| Database queries | src/Repository/ |
| Data model / schema | src/Entity/ |
| Admin or public pages | src/Controller/Admin/ or src/Controller/ |
| Twig templates | templates/ |
| CLI commands | src/Command/ |
| Translations | translations/messages.{en,de,cn}.yaml |
4. Make your change¶
Follow the pattern for the layer you're in:
- Service —
readonlyclass, constructor injection, single responsibility → Patterns § Service - Repository —
createQueryBuilder(), intent-revealing method names → Patterns § Repository - Entity — Doctrine attributes, backed enums, no logic → Patterns § Entity
- Schema change — generate a migration after editing an entity → Patterns § Migrations
5. Run the checks¶
just fixMago # Auto-format code (always run before testing)
just testUnit # Run unit tests
just test # Run all tests + static analysis + code style
All checks must pass before opening a PR.
6. Open a PR¶
See Contributing for the PR workflow and code review checklist.