phpBB

Development Wiki

Working with Git

From phpBB Development Wiki

Revision as of 04:27, 3 March 2010 by Exreaction (Talk | contribs)

Basics

Cloning

Clone the master phpBB3 repository.

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

Branches

  • master: Mainline for releases
  • develop: Development branch for the next feature release
  • develop-olympus: Development branch of named release

Developers

Developers should fork a copy of the repository on GitHub from [1] and then clone as instructed by GitHub.

Configuration

  • E-mail address:
    git config --add user.email username@phpbb.com
  • Add the upstream remote (you can change 'upstream' to whatever you like):
    git remote add upstream git://github.com/phpbb/phpbb3.git

Creating local branches

To work on phpBB you need to create local branches of whichever develop branches you need, issue the following command to perform this operation:

git checkout -b develop origin/develop

Work flows

Pulling in upstream changes

You will need to merge in changes made to the upstream repository for them to appear in your fork, the steps to do this follow. I'm assuming you are performing this on the develop branch, but it could be a bug fix branch or a develop release branch, so ensure you are on the correct branch using git branch and change with git checkout if required.

  1. Pull the changes from the upstream develop branch:
    git pull upstream develop
  2. Push the changes back to your fork (substitute develop for the current branch):
    git push origin develop

Bug fixing

Ensure you are using the correct develop branch first and not a master branch.

  1. git branch bug/12345 # Create a new branch for your bug fix
  2. git checkout bug/12345 # Switch to the new branch
  3. Make your changes
  4. git add <files> # Stage the files
  5. git commit -m "Message" # Commit staged files
  6. git push origin bug/12345 # Push the branch back to github[/list]

Windows

Quick info for those with TortoiseGit (and used to working with TortoiseSVN)

Create your own SSH key
Note: I used the OpenSSH option during installation, so I am not sure if this works for the other option or if you are supposed to do it some other way
http://help.github.com/msysgit-key-setup/
TortoiseGit will automatically use the SSH key

Then simply clone the repository to your local system and the rest is mostly like TortoiseSVN.

Pull - Grab the updates from upstream
Commit - Commits the changes locally (you must Push or Sync to commit the changes to the repository)
Push - Pushes the changes that were locally made into the repository
Sync - Pushes/Pulls changes with more options