This repository is a collection of packages for the Flow framework (learn more on http://flow.neos.io/). The repository is used for development and all pull requests should go into it.

If you want to use the Flow framework, please have a look at the documentation: https://flowframework.readthedocs.org/en/latest/

If you want to contribute to Flow Framework and want to set up a development environment, then follow these steps:

composer create-project neos/flow-development-distribution flow-development dev-master --keep-vcs

Note the -distribution package you create a project from, instead of just checking out this repository.

The code of the framework can then be found inside Packages/Framework, which itself is the flow-development-collection Git repository (due to the --keep-vcs option above). You commit changes and create pull requests from this repository. To commit changes to the framework switch into the Framework directory (cd Packages/Framework) and do all Git-related work (git add ., git commit, etc) there.

In the root directory of the development distribution, you can do the following things:

To run tests, run ./bin/phpunit -c ./Build/BuildEssentials/PhpUnit/UnitTests.xml for unit or ./bin/phpunit -c ./Build/BuildEssentials/PhpUnit/FunctionalTests.xml for functional/integration tests. If you are on 6.0 or later, you can also run ./bin/psalm --config=Packages/Framework/psalm.xml to run static analysis tools.

To switch the branch you intend to work on: git checkout 5.3 && composer update

For more detailed information, see https://discuss.neos.io/t/development-setup/504 and https://discuss.neos.io/t/creating-a-pull-request/506