Development setup

Guide to getting a development setup

In order to contribute code you’ll need a development setup. There are a couple of approaches to achieving that. You’ll need to have a environment suited for running Flow and a few additional things depending on the contribution.

Cloning the development distribution (recommended):

Neos

Latest

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

Specific version

composer create-project neos/neos-development-distribution neos-development 2.0.x-dev --keep-vcs --stability=dev

Link: https://github.com/neos/neos-development-distribution

This is a full distribution containing the required dependencies for developing Neos including the neos-development-collection and the flow-development-collection.

Check out a different development branch

git checkout 2.0
composer update

Flow

Latest

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

Specific version

composer create-project neos/flow-development-distribution flow-development 3.0.x-dev --keep-vcs --stability=dev

This is a full distribution containing the required dependencies for developing Flow including the flow-development-collection.

Check out a different development branch

git checkout 3.0
composer update

Link: https://github.com/neos/flow-development-distribution

Adjust existing distribution:

Neos

Remove the requirement on typo3/neos

composer remove --no-update "typo3/neos"
composer remove --no-update "typo3/neos-nodetypes"

Add the neos-development-collection and flow-development-collection to your composer.json file according to composer.json (varies depending on the version).

Example:

composer require --no-update "neos/neos-development-collection:3.0.x-dev"
composer require --no-update "neos/flow-development-collection:@dev"
composer update

Flow

Remove the requirement on typo3/flow

composer remove --no-update "typo3/flow"

Add the neos-development-collection and flow-development-collection to your composer.json file according to composer.json (varies depending on the version).

Example:

composer require --no-update "neos/flow-development-collection:3.0.x-dev"
composer update

Fork the repository

In order to create Pull-Requests you first need to fork the repository. Once done you can make that forked repository your origin so that you don’t accidentally push to the neos repository:

Neos

git remote rename origin upstream
git remote add origin https://github.com/<your-gh-username>/neos-development-collection.git 

Flow

git remote rename origin upstream
git remote add origin https://github.com/<your-gh-username>/flow-development-collection.git 

TBD:

  • Tips
  • Branches
  • Hub
  • Next steps (creating pull request)
  • Tests
  • Travis
7 Likes