Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
92 lines (61 loc) · 2.06 KB

DEVELOPMENT.md

File metadata and controls

92 lines (61 loc) · 2.06 KB

Development Guide

This guide covers development setup, testing, and code quality for the Anonymize Bundle.

Table of contents

Development Setup

Using Docker (Recommended)

The project includes Docker Compose configuration for easy development setup.

# Start the container
make up

# Install dependencies
make install

# Run tests
make test

# Run tests with coverage
make test-coverage

# Run all QA checks
make qa

Without Docker

If you prefer to run everything locally:

composer install
composer test
composer test-coverage
composer qa

Testing

The bundle includes comprehensive tests. All tests are located in the tests/ directory.

Test Statistics

Run composer test or make test-coverage for current test and coverage statistics. See the README "Current Status" section for the latest numbers. The test suite includes unit and integration tests for fakers, services, commands, events, and attributes.

Running Tests

# Run all tests
composer test

# Run tests with coverage report
composer test-coverage

# View coverage report
open coverage/index.html

Coverage by Component

  • Fakers, services, commands, and attributes are covered by the PHPUnit suite; see make test-coverage for current line coverage (target: 100% on src/).

Code Quality

The bundle uses PHP-CS-Fixer to enforce code style (PSR-12).

# Check code style
composer cs-check

# Fix code style
composer cs-fix

Contributing

We welcome contributions! Please see CONTRIBUTING.md for details on how to contribute to this project.

For information about our Git workflow and branching strategy, see BRANCHING.md.