Contributing to FLOW3

Got time, a computer and a brain? Here is how you can help:

Report and Validate Issues

We don’t code bugs, at least not on purpose. But if you find one, report it in our issue tracker. But please help us to solve it by attaching a detailed description of how to reproduce the issue. If you can provide a unit test that shows the bug, this rocks big time.

  • Tasks: Find bugs, describe them, reproduce them in a unit test
  • Skills needed: Attention to detail, knowledge about PHP and PHPUnit is a plus

Report bugs in the Forge Issue Tracker !

Improve Documentation

A complex system like ours needs a lot of documentation. And despite the complexity that documentation should be easy and fun to read. Right?

  • Tasks: Proof read existing documentation, writing new documentation
  • Skills needed: Writing skills and very good english are a must

For a quick start follow the these simple steps:

  1. Checkout the Package TYPO3.FLOW3 with Git, and set up the git repository so you can contribute:

    $ git clone git://git.typo3.org/FLOW3/Packages/TYPO3.FLOW3.git
$ # set up git so you can push to Gerrit

    If you do not know how to set up Git correctly, follow the easy steps of our git wizard. Of course you can also use the package TYPO3.FLOW3 from any FLOW3 distribution you installed already.

  2. Read the documentation and adjust it as needed.

  3. Push it to gerrit, or alternatively upload a patch with the changes to the Forge Issue Tracker.

If you like to see a rendered HTML result of the documentation a few more steps are necessary:

  1. Use any installed FLOW3 distribution. If you don’t have FLOW3 installed, install the FLOW3 Base distribution as described in the Installation section of the Getting Started chapter.

  2. Set up git for use with gerrit (our git wizard might help with that).

  3. Install Sphinx to render the documentation.

  4. Import and activate the package TYPO3.DocTools. It provides you with a command to render standalone documentation.

    $ ./flow3 documentation:render --format html

  5. Read the documentation and adjust it as needed.

  6. Push it to gerrit, or alternatively upload a patch with the changes to the Forge Issue Tracker.

Work on the Code

You found a bug? Have an idea for a missing feature? Found clever solution to an open task? Just write the code and submit it to us for inclusion. Do it on a regular basis and become famous. So they say.

  • Tasks: Write clean and useful code. Bonus points for beautiful code :-)
  • Skills needed: good to expert PHP knowledge, good understanding for OOP, knowledge about patterns and “enterprise architecture” is a plus