Developer Resources

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.

Getting Started

• Development Process
• Overview of Cyrus development environment
• Compiling
• Installing Cyrus
• Developer Test Environment
• Test Coverage
• JMAP support

Contributing

• Contributing to the documentation
• Documentation style guide
• The CUnit (C) test suite
• The Cassandane (Perl) 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.

• Namespaces: a developer view
• Developer Libraries
• Cyrus APIs
• Thoughts & Notes
• Guidance for Developers

This diagram shows the Master State Machine.

Releasing

• Releasing Cyrus IMAP - normal releases
• Releasing Cyrus IMAP - major releases
• Releasing Cyrus IMAP - developer snapshots