phpBB

Development Wiki

Difference between revisions of "Git"

From phpBB Development Wiki

(See also link)
Line 32: Line 32:
  
 
Since phpBB 4 is still far from a stable version, there is only one development branch, in which all development takes place.
 
Since phpBB 4 is still far from a stable version, there is only one development branch, in which all development takes place.
 +
 +
== How to contribute? ==
 +
Please post your changes for review in a new topic on the [http://area51.phpbb.com/phpBB/viewforum.php?f=78 4.0/Rhea RFCs & Patches forum at area51]. Please either provide a link to your commit or branch on github or attach a patch created with git format-patch. For larger changes consider [[phpBB4/RFC|writing an RFC]] first.
  
 
= phpBB3 =
 
= phpBB3 =
Line 44: Line 47:
  
 
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
 
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
 +
 +
== How to contribute? ==
 +
When fixing a bug, please post in the bug tracker. When adding a feature to 3.1 post your patch for review in a new topic on the [http://area51.phpbb.com/phpBB/viewforum.php?f=84 3.1/Ascraeus RFCs & Patches forum at area51]. Please either provide a link to your commit or branch on github or attach a patch created with git format-patch. For larger features or changes consider posting an RFC on area51 first.
  
 
== Workflow ==
 
== Workflow ==

Revision as of 04:12, 7 March 2010

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.

phpBB4

Repository

git://github.com/phpbb/phpbb.git

Branches

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

How to contribute?

Please post your changes for review in a new topic on the 4.0/Rhea RFCs & Patches forum at area51. Please either provide a link to your commit or branch on github or attach a patch created with git format-patch. For larger changes consider writing an RFC first.

phpBB3

Repository

git://github.com/phpbb/phpbb3.git

Branches

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

How to contribute?

When fixing a bug, please post in the bug tracker. When adding a feature to 3.1 post your patch for review in a new topic on the 3.1/Ascraeus RFCs & Patches forum at area51. Please either provide a link to your commit or branch on github or attach a patch created with git format-patch. For larger features or changes consider posting an RFC on area51 first.

Workflow

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.

phpBB2

Repository

git://github.com/phpbb/phpbb3.git

Branches

See Also