First of all, thank you for contributing, you are awesome!
Here are a few rules to follow in order to ease code reviews, and discussions before maintainers accept and merge your work.
You MUST run the test suite.
You MUST write (or update) unit tests.
You SHOULD write documentation.
One may ask you to squash your
too. This is used to "clean" your Pull Request before merging it (we don't want
commits such as
fix 3, etc.).
Running the test suite
Ensure that the required vendors are installed by running
The test suite requires the
php5-sqlite extensions to be installed.
PHPUnit should be installed by composer. Run the tests with the
Alternatively you can use the
runTests.sh bash script present at the project root.
Default usage example (This runs all tests with your current PHP version against
all supported Symfony versions.):
You can also set a specific Symfony version to test against and/or pass the arguments for PHPUnit as arguments to the script. Usage example:
SYMFONY_VERSION=2.7.1 ./runTests.sh --filter testCustomFileNameProperty
Note: The script was prepared to run under Ubuntu and using Bash so it might need further validation for other OS.