Development Wiki


From phpBB Development Wiki

Revision as of 15:29, 6 March 2010 by Naderman (Talk | contribs)

This document provides details of the various repositories and branches available as part of the phpBB Git infrastructure, for details of how to use git please see Working with Git.

Commit Messages

A good commit message looks like this:

[branch you are working on] A short explanation of the change.

A more detailed explanation of which things exactly were changed and for
what reasons. This can span multiple paragraphs for a bigger change. And
it should really make clear all the changes to anyone reading this commit
message without further context.

An example:

[feature/request-class] Adding a request class based on the one found in ascraeus-experiment.

The well known request_var function is now a wrapper that calls a method
on a phpbb_request object. The class provides additional functionality.
It can replace all super globals with special objects that throw errors
when being accessed. They still allow isset operations to keep backward
compatibility with isset($_POST['var']) checks. The phpbb_request class
implements the phpbb_request_interface which is available for easy mocking
of input in tests.





Since phpBB 4 is still far from a stable version, there is only one development branch, in which all development takes place.





This means all bugfix development should take place on develop-olympus and will be merged into develop. All feature development should take place in develop. Read more about the workflow in the next section


To better explain the workflow we will be following we have created an image that visualises the different branches and how they relate to each other. This workflow is based on the Git branching model by Vincent Driessen.

Error creating thumbnail: Unable to save thumbnail to destination

View in large or as svg.