wiki:TracDev

Context Navigation

Version 32 (modified by Christian Boos, 14 years ago) ( diff )
improve presentation and wording

Trac Development

Release Notes: 0.10, 0.11, 0.12, 0.13, 1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 1.8

API changes: 0.10, 0.11, 0.12, 0.13, 1.0, 1.1, 1.1.1, 1.1.2, 1.1.3, 1.1.4, 1.1.5, 1.2, 1.3, 1.4, 1.6

These pages provide information about the development of Trac and extensions for Trac (such as WikiMacros and other kinds of plugins). Most of the information was written for 0.9, but we try to maintain it up-to-date with the latest version of Trac (currently 0.13dev).

We also do our best to signal what has been deprecated/removed between releases, see our Release Notes and summary of API changes.

Starting with 0.13dev, each ticket has an API change field, so we hopefully won't get any change remain undocumented.

How to get started?

Start by doing a Development Environment Setup and become familiar with installing Trac and creating new TracEnvironments.

Then, you should read a bit, in order to get familiar with Trac's ComponentArchitecture, PluginDevelopment and DatabaseApi. The TracTroubleshooting page contains debugging tips which are also quite useful during development.

When you're ready hacking the code, make some modifications, see what happens, experiment. When you're about to make real changes that you want to contribute back, note that we're picky about our CodingStyle and you'd better follow them when SubmittingPatches. In order to be accepted, they should pass the UnitTests and the FunctionalTests. Ideally, you should also contribute new tests.

Incidentally, discussions about Trac Development happen on the Trac-Dev mailing list. Trac-Dev can also be used as an InterWiki prefix in order to refer to specific mails sent to that MailingList, e.g. Trac-Dev:1, or googlegroups:trac-dev:1b9c4e3eaeda3a0d (in the latter example, the "id" being the one of the Individual Message).

See TracDev/Branches and TracDev/Proposals as well as the TracDev/ToDo, for an overview of the open topics (besides the roadmap, of course).