Edgewall Software

Trac Development

Release Notes: 0.10, 0.11, 0.12, 0.13, 1.0, 1.1
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.3
API Doc: 0.11, 0.12, 1.0, 1.1 (*)

These pages provide information about the development of Trac and its extensions. It is written for skilled Python developers who have experience using Trac.

Development is largely coordinated online.

Source code is managed in repositories and for Trac this is a combination of the main trunk in Subversion and mirrors in Bitbucket and GitHub. See TracRepositories, TracSubversion, TracGit and TracMercurial for more information.

We also keep track of what has been deprecated or removed between releases, see our Release Notes and the summary of API Changes. API Changes are summarised using the API change field attached to every ticket; this is a feature implemented since 1.0dev.

How to get started?

Start by setting up a Development Environment and become familiar with installing Trac and creating new TracEnvironments.

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

When you're ready to contribute changes, note that we're picky about our CodingStyle when SubmittingPatches. For changes to be accepted, the modified Trac source should still pass the UnitTests and the FunctionalTests. Ideally, also contribute new tests.

Discussions about Trac Development happen on the Trac-dev mailing list. New development ideas are usually best discussed first on that list, it's a quick and easy way to get feedback on any given topic or question. As usual, search the archive first, to avoid rehashing old discussions. For longer term developments, or for documentation purposes, use the wiki.

To refer to a mail from Trac-dev in this wiki, use the googlegroups InterWiki prefix, for example: googlegroups:trac-dev:1b9c4e3eaeda3a0d. You can see the message identifier in the address bar of your browser when viewing the message in Individual Message view mode. You can go there from the default threaded view by clicking on More options and then on the Individual Message or Show Original links.

Development guides

Getting Started Contributing
Overviews Testing
Miscellaneous Thematic Guides Translation
Development Proposals Development Branches

Blueprints for major changes on a topic:

Documentation for ongoing work in code branches:

See also:

Scratch Pad for developers Ideas from users

Last modified 5 weeks ago Last modified on Oct 20, 2015 4:47:07 PM