Contribute to Neos framework

An error in the documentation? A bug for which you want to propose a fix? A new feature to integrate into the framework? In this case, you have the possibility to contribute to the framework.

To do this, in Azure Devops you can create a pull request that will be analyzed by the framework team and eventually integrated into Neos.

Understanding Neos branches

Neos framework code is grouped into the Neos git repository.

The develop branch is the code on which the team is currently working, for the next version of the framework.

If you want to check or contribute to a specific version, the code is located in a release/X.Y branch. Theses branches (ex: release/1.21, release/2.0) represents the last minor version code.

All patches are present inside a release branch. It is possible to retrieve the code for version X.Y.Z by fetching the X.Y.Z tag in the release/X.Y branch.

Create a pull request

If you want to contribute to the code, you first need to create a new branch from the target branch (eg: develop for the next framework version or release/X.Y for a patch).

By convention, we name our branches task/XXXXX-whatever-you-want with XXXXX the identifier of the task in Azure Devops.

You can then make your changes and publish the branch. Next step is to create a pull request as draft and run all the pipelines to check the conventions imposed by the framework.

Once your pipelines are successful, you can then contact the Neos team so they can review the pull request.

Publish a nightly build

If you want to test your modification in a deployed environment, you may need to publish a version of the framework. To do this, you can launch the Nightly build pipeline on your branch.

Once the pipeline is successful, you can deploy it using the version number associated to your build.