contributing.md

Contributing to Dirigent

Dirigent is an open-source project, contributions of all kind are welcome, including financial contributions.

Running Dirigent locally

To run Dirigent locally, follow the Running from source code guide in the documentation, up to the Configure services section.

Additional requirements:

• Symfony binary
• Docker

# Optionally, copy the example Docker Compose configuration override file
cp compose.override.example.yaml composer.override.yaml

# Start Docker services
docker compose up -d

# Start Symfony local server
symfony server:start -d

Lint & test your code

Running PHPUnit tests

Before running the tests, make sure the testing database is ready:

symfony console --env=test doctrine:database:create --if-not-exists
symfony console --env=test doctrine:schema:update --force
symfony console --env=test doctrine:fixtures:load --no-interaction

Run the PHPUnit tests:

symfony run bin/phpunit