Skip to content

Latest commit

 

History

History
33 lines (23 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

33 lines (23 loc) · 1.13 KB

CONTRIBUTING

Coding Standards

This project follows Symfony's Coding Standards. Before you submit your PR, make sure to run PHP-CS-Fixer, which will automatically format the code:

php-cs-fixer fix

Tests

Before submitting your PR, make sure tests pass:

composer install
vendor/bin/phpunit

Documentation

Documentation is built using Sphinx.

Setup

Make sure you have pip installed and then install the needed dependencies inside a virtualenv environment, in order not to pollute your system:

sudo pip install virtualenv
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt

Building the docs

Build the documentation with:

source venv/bin/activate
sphinx-build Resources/doc Resources/doc/_build

Alternatively, use sphinx-autobuild to watch changes and automatically refresh the browser:

source venv/bin/activate
sphinx-autobuild -B Resources/doc Resources/doc/_build