Developer Resources

The Development Process

We want it to be easy to contribute to Cyrus, whether it's documentation improvements, bug fixes, new features, or optimizations.

The contribution guidelines below outline the process that you'll need to follow to get a code patch merged. By making expectations and process explicit, we hope to make it easier for you to contribute.

• Contributing to the documentation
• Contributing code and tests
• Using the Cassandane test suite

Cyrus Internals

These documents are intended for persons interested in contributing to the Cyrus IMAP development effort, or for those interested in lower- level details about how Cyrus is implemented.

• Cyrus APIs
  • CyrusDB API
  • cyrusdb API
  • Index API
  • Mailbox API
• Thoughts & Notes
  • Cyrus IMAP Server: Sieve Bytecode
  • Cyrus CalDAV Scheduling Flowchart
  • Cyrus IMAP Server: Notes
  • Cyrus IMAP Server: Prot Events
• Guidance for Developers
  • Cyrus IMAP Server: Hacking
  • Cyrus IMAP Server: Internationalization
  • Cyrus IMAP Server: Locking
  • Cyrus IMAP Server: Mailbox File Formats
  • Cyrus IMAP Server: Namelocks
  • Cyrus IMAP Server: prot layer
  • Cyrus IMAP Server: Replication Examples
  • Cyrus IMAP Server: Replication Protocol v2.4+
  • Cyrus IMAP Server: Special Characters
  • Cyrus IMAP Server: var directory structure

This diagram shows the Master State Machine.