Developer Info

Information on working on the Mercurial code base.

1. Start hacking

• Main repository - browse or clone the source (see DeveloperRepos for other repositories)

• WritingExtensions - how to write Mercurial extensions

• Theming - how to create new styles for Mercurial's web interface

• DeveloperBasics - some basic code examples

• MercurialApi - The internal API for Mercurial

• TranslatingMercurial - how to translate Mercurial into your own language

2. Contributing code

• Contributing changes - how to send us your changes

• Easy bugs - tasks flagged as easy, a good entry point for new contributors

• UIGuideline - how to make consistent UI choices

• Coding style - how to make your code pretty

• WritingTests - how to add tests to the test suite

• HelpStyleGuide - how to write nice help

• CompatibilityRules - how we keep our existing users from crying

• ReviewProcess - how you can help getting patches in

3. Internals

• Design - Mercurial's data structures and how it uses them

• FileFormats - list of Mercurial's disk file formats

• WhatGoesWhere - the project architecture

• WireProtocol - the push/pull changegroup protocol

• DebuggingFeatures - how to poke around in Mercurial's internals

4. Working with the community

• MailingLists

• ManagingBugs - how to work with the bug tracker

• TimeBasedReleasePlan

• DeveloperRepos - where to find various public repositories of Mercurial work

• IRC - where most of the developers hang out

• CategoryMeetings - When we get the community together (about every 6 months)

5. Feature proposals

• CategoryNewFeatures - All page discussing new features.

6. Developer tips

• MacOSXTools - Installing the tool chain on Mac OS X.

• Using Wine to test Windows support under Linux

• Easy way of starting Mercurial hacking on Windows with HackableMercurial

CategoryDeveloper