Getting ready for a Bug Day
To participate fully in a Bug Day you must be well-equipped. This page will help you get set. If you're in a hurry, skip to the quick checklist at the bottom of the page.
Contents |
TYPO3 Install
To be able to work on bugs, you need a locally running copy of TYPO3. This page is not meant to be a complete installation guide, but you need to make sure that your machine is running PHP, MySQL and Apache, to be able to install a local copy of TYPO3. If you don't have anything, your best bet is to get some complete package like:
- XAMP (all platforms, free)
- ZendServer CE (all platforms, free)
- MAMP (Mac, free or commercial)
- WAMP (Windows, free)
Source Code
All work on the Core of TYPO3 is usually done on the current development versions of each branch (i.e. TYPO3_4-2, TYPO3_4-3, etc.). The new version of TYPO3 being developed is refered to as "master".
Development versions of TYPO3 can not be downloaded simply from typo3.org. They must be fetched from the version-control repository where the source code is kept. See here on how to get the newest version.
This source code is stored in a Git repository. To get files from it you will need a Git client. At the simplest you can install a command-line client, but there are quite a few pieces of software out there that will provide you with a more user-friendly interface. Refer to the list below for some advice.
Once you have checked out a copy of the TYPO3 source code, use that in your local install instead of some downloaded package.
Git and Subversion clients
To get the newest TYPO3 sourcecode you will need a Git client. See here.
Other code (e.g. sourcecode of extensions can still be managed through Subversion. To get the code from there, you can use one of the following clients:
- Tortoise SVN (Windows, open source)
- Cornerstone (Mac, commercial)
If you install an Integrated Development Environment (IDE, see below), you will probably have an integrated SVN/Git client.
Read more about Subversion usage.
Integrated Development Environment (IDE)
If you want to work on the TYPO3 source code, it is probably a good idea to get yourself a so-called "Integrated Development Environment" or IDE for short. With a IDE you define a project, point it to the place where the source code is stored on your hard drive and the IDE will scan all that code. Once it is done the IDE will simplify your work by proposing names of classes, methods, variables, etc.
Here are some IDEs, all are cross-platform:
- Eclipse (slow but powerful, open source)
- Netbeans (easier to install and get running than Eclipse, open source)
- ZendStudio, a commercial version of Eclipse made by Zend
Bug tracker
For any bug to be worked on, it needs to be properly reported in the Forge bug tracker (http://forge.typo3.org/projects/typo3v4-core/issues). To be able to interact with the bug tracker (and not just browse the reports), you will need to be logged in. forge.typo3.org uses a single-sign on system connected to typo3.org. So if you have a typo3.org account, you can log into forge.typo3.org too. If you don't have a typo3.org account, now is the right time to create one.
To learn more about how to use the bug tracker, read Bugfixing Team.
To learn more about patches and diff files, read Diff and Patch
Gerrit
Patches are discussed in Gerrit, which you can reach at review.typo3.org. You can log in with the same data which you use to log in to typo3.org.
To learn more, please read our pages about contributing to the TYPO3 Core.
IRC
Gerrit is for a formal discussion about patches. During a Bug Day, quicker and more informal discussion is needed. For this reason we use a IRC channel (irc://irc.freenode.net/#typo3-bugday). So you will need to equip yourself with an IRC client too. Here are some clients:
Quick checklist
- local PHP, MySQL, Apache stack
- local TYPO3 install running and using source code from Git repository
- Git client
- IDE or similar code editor
- typo3.org account
- Newsgroup client
- IRC client
- Beer, coffe, pizza, loud music, extra batteries, whatever you need to keep going
