Zope Developer Information

Intended Audience

This guide is for developers who are working on the various Zope-related software projects, rather than for developers who work with those projects’ released software to build applications. Developers in the latter category should consult the relevant documentation for that software, e.g.:

• Zope Toolkit Documentation
• The Zope2 Book
• The Zope2 Developers’ Guide
• Zope3 API Documentation

Contributor Roles

There are many different ways you might contribute to a Zope-related project. This guide tries to allow for different levels of participation in such projects. For instance:

• Susan might find a bug in the project while using the project’s software in her own application.
• Later, she might volunteer to help triage and fix bugs during a bugday.
• She might attend a sprint to work on an important new feature in the project with other volunteers.
• Eventually, Susan might volunteer to assume responsibility with other team members for the ongoing maintenance and release management of the project.

Resources for Contributors

• Browsing the Repository
  • Subversion Web Interfaces
  • Bazaar Branches
• Bug Trackers for Zope-related Projects
  • Zope Toolkit
  • Zope2
  • Grok
  • BlueBream
• Zope IRC Channels
  • #zope
  • #zope3-dev
  • #grok
  • #bluebream
• Zope Mailing Lists
• Zope Development Culture
  • Coding Standards
  • Layout and Conventions
  • Running Tests using zc.buildout

Contributing as a Non-Committer

• Reporting Bugs against Zope Packages
  • Identifying the Project which Has the Bug
  • Writing the Bug Report
  • Useful Patches for the Bug Report
  • Bug Triage and Workflow
• Documenting Zope Packages Using Sphinx
  • Building the HTML Documentation
  • Building the HTML Documentation using zc.buildout
• Contributing as a Non-Committer using Subversion
  • How-To: Get a Read-only Subversion Checkout
  • How-To: Get a Read-only Checkout from a Subversion Mirror
  • Working inside the Read-only Checkout
  • How-to: Submit a patch from your Subversion checkout
• Contributing as a Non-Committer using Bazaar
  • How-to: Branch using the Bazaar mirror
  • How-to: Branch with Bazaar directly from Subversion
  • How-to: Submit a patch from your Bazaar branch
  • How-to: Push your Bazaar branch to Launchpad
  • How-to: Request a merge

Becoming a Zope Committer

• Becoming a Committer
  • Applying for Committer Status
  • Depositing your SSH public key(s)
  • Subscribe to the Mailing Lists
• Writable checkouts
  • Before you start
  • Doing checkouts (Linux, MacOS-X, Un*X)
  • Doing checkouts (Windows)

Repository committee operations (internal)

• Procedure for accepting new committer applications

Zope CVS Repository (obsolete)

• How-to: Get a read-only CVS checkout