CONTRIBUTING.md

Contributing to Black Flag

Tests

PHPunit

Acceptable coverage baseline: 80%

Locally run the tests suite with make sure or:

  docker-compose exec php vendor/bin/phpunit --testdox

Mutation testing

Infection

• Acceptable Mutation Score Indicator (MSI): 80%
• Acceptable Covered Code Mutation Score Indicator: 90%

Locally run the tests suite with make bulletproof or:

  docker-compose exec php vendor/bin/infection

Code quality

phpstan

• 🥇 standard: level 8
• configuration: php/phpstan.neon

psalm

• 🥈 standard: level 2
• configuration: php/psalm.xml

Locally run the static analysis with make better or:

  docker-compose exec php vendor/bin/phpstan analyse
  docker-compose exec php vendor/bin/psalm