neos/flow-development-collection

Flow packages in a joined repository for pull requests.

Installs: 98 113

Dependents: 4

Suggesters: 0

Stars: 107

Watchers: 24

Forks: 140

Open Issues: 168

Type:neos-package-collection

6.0.2 2019-10-14 10:49 UTC

README

Travis Code Climate StyleCI Latest Stable Version License Documentation API Docs Slack Discussion Forum Issues Translation Twitter

Flow development collection

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/

Contributing

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 4.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, which is 4.3 currently), 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