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:
Clone and install the flow dev distribution https://github.com/neos/flow-development-distribution via git and composer or use this shorthand:
composer create-project neos/flow-development-distribution flow-development @dev --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 test and commit changes to the framework switch into the Framework directory (cd Packages/Framework).
Here you can do all Git-related work (git add ., git commit, etc).
Unit tests can be run here via ../../bin/phpunit -c ../../Build/BuildEssentials/PhpUnit/UnitTests.xml, functional tests via ../../bin/phpunit -c ../../Build/BuildEssentials/PhpUnit/FunctionalTests.xml and static analysis via composer lint.
To switch the branch you intend to work on run this command in the root of the dev distribution:
git checkout 8.3 && composer update
Note
We use an upmerging strategy, so create all bugfixes to lowest maintained branch that
contains the issue (typically the second last LTS release, check the diagram on https://www.neos.io/features/release-process.html), or master for new features.
For more detailed information, see https://discuss.neos.io/t/development-setup/504 and https://discuss.neos.io/t/creating-a-pull-request/506