Skip to content

Contributing

Contributions to the MeetAgain core and bundled plugins are welcome.

Development Setup

Follow the Getting Started guide to get a running dev environment, then run the full test suite to confirm everything is green:

just test

This runs unit tests, functional tests, and all Mago static analysis checks.

Code Standards

The project uses Mago for formatting, linting, and architecture validation.

# Format code
just fixMago

# Check for issues (run before submitting a PR)
just checkMagoAll

Key rules:

  • declare(strict_types=1) on every PHP file
  • All services must be readonly (exception: services that hold a per-request memo field)
  • Thin controllers — business logic belongs in services
  • No direct repository access from controllers (use services)
  • AAA pattern in tests (// Arrange / // Act / // Assert comments)

Running Tests

# All tests
just test

# Unit tests only
just testUnit

# Functional tests only
just testFunctional

# Specific test file
just testUnit plugins/dishes/tests/Unit/SomeServiceTest.php

Translations

The project ships three canonical UI locales: en (source), de, zh. All user-facing strings must flow through the translator - no English literals in templates, flash messages, form labels, validator messages, or activity messages.

Translation keys use nested YAML namespaces and dot-notation:

# translations/messages.en.yaml
admin_member:
    col_name: 'Name'
    status_active: 'Active'

{{ 'admin_member.col_name'|trans }}

Contributing a new locale means committing a real, human-translated translations/messages.<code>.yaml alongside the existing three. Machine-translation dumps will not be accepted. The language dropdown also needs a translations/language_selector/messages.<code>.yaml with the language_* keys translated into the new locale.

Useful commands:

# Check for missing keys in en / de / zh
just checkTranslations

# Scan templates and PHP for usages of a key
just app "app:translation:scan events.button_save"

Plugin Contributions

If you are contributing a new bundled plugin, read the Plugin Development Guide first.

Plugins must:

  • Not modify core entities
  • Use junction tables for any relationship to core entities (store IDs as INT, not foreign keys)
  • Work correctly when disabled (core must function without them)
  • Include fixtures in the plugin group
  • Include at least basic unit tests

Submitting Changes

  1. Fork the repository
  2. Create a branch from main
  3. Make your changes, run just fixMago and just test
  4. Open a pull request against main with a clear description of what and why

Reporting Issues

Open an issue on GitHub with:

  • What you expected to happen
  • What actually happened
  • Steps to reproduce
  • PHP / Symfony / Docker versions if relevant