Contributions are welcome and will be credited.
We accept contributions via Pull Requests on Github.
Do PHP the Right Way, keep the PHPstan level maxed, include tests with proper
coverage, and run bin/prepare-commit during development and before committing.
Infection testing is by default only done on changed files. It is recommended to run
bin/infection before finishing a PR to evaluate infection status of the entire project.
There is a full Symfony test project in tests/Fixture for functional testing. It can be run
standalone as well if you have the Symfony CLI installed for easy development of test cases both
for functional tests and for actual visual development:
bin/testsiteCheck the Symfony CLI output for IP and port information where the site is running.
To serve the MkDocs site in /docs ensure you have installed Docker, and run the provided script
to serve the docs with live updates:
bin/serve-docsBy default MkDocs binds to port 8000 and is thus accessible on http://127.0.0.1:8000. If you get a port conflict, pass the bind target as a parameter:
# Bind to localhost port 4000
bin/serve-docs 127.0.0.1:4000On pushes to the master branch the docs are automatically released to https://omines.github.io/antispam-bundle/