Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (37 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

52 lines (37 loc) · 1.25 KB

Contributing

Thank you for considering contributing to Doctrine Encrypt Bundle.

Development setup

  1. Clone the repository and install dependencies:

    composer install

  2. Run tests:

    composer test
# or with Docker: make up && make test

  3. Code style:

    composer cs-check
composer cs-fix

  4. Full QA:

    composer qa
# or: make qa

Code style

The project uses PHP-CS-Fixer with the rules in .php-cs-fixer.dist.php. Please run composer cs-fix before submitting a pull request.

Tests

  • Add or update unit and functional tests as needed.
  • Run composer test (or make test) and ensure all tests pass.

Pull requests

  • Open an issue first to discuss larger changes.
  • Branch from main (or the default branch), make your changes, and open a PR.
  • Keep the scope focused; split unrelated changes into separate PRs when possible.
  • Update the documentation under docs/ if you change configuration, commands, or behavior.

Reporting issues

  • Use the GitHub issue tracker.
  • Include PHP, Symfony, and Doctrine ORM versions.
  • Provide a minimal example or steps to reproduce when reporting bugs.

Thank you for contributing.