Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

55 lines (40 loc) · 1.63 KB

Contributing to Passbolt API

Prerequisite

Setup

Quickly spin up development environment with default configuration:

  1. Clone passbolt api repo
  2. Start ddev
    ddev start
  3. Initiate dev environment (run only once)
    ddev init_passbolt

All set! Navigate to https://passbolt-api.ddev.site/ and start contributing to passbolt 💪

Running tests

The test database is already created for you.

To run full test suite:

ddev composer test

To run a subset of tests:

ddev exec -d /var/www/html "vendor/bin/phpunit --filter <TestName>"

Run code quality checks

  • Coding style violations: ddev composer cs-check
  • Autofix coding style errors: ddev composer cs-fix
  • Static analysis: ddev composer stan and ddev composer psalm
  • All in one command (run PHPStan, Psalm and coding standards check): ddev analyze

Contributing to the Clients

How do I contribute to the translation

For contributing to the translations of this repository, you will need to create an account and propose changes at https://passbolt.crowdin.com/.