Contribute to Cappuccino

As an open source project, your contributions are important to the future of Cappuccino. Whether you're looking to write code, add new documentation, or just report a bug, you'll be helping everyone who uses Cappuccino in the future.

Getting the Code

Cappuccino is hosted on Github using the Git version control system. You can get the code with the following command:

git clone git://github.com/cappuccino/cappuccino.git

If you don't have Git installed, don't worry, it's simple. Check out the official download page, or view the installation guide on the Git Wiki.

You can also download the latest source code as a zip file or tarball. These links go to the top of the tree, but using Github, you can find any specific revision on any branch and download either file.

For help getting set up with the build tools and checking out the source code, follow this tutorial.

Reporting Bugs

We use the GitHub issue tracker to report and follow bugs in Cappuccino. If you think you've found a problem in Cappuccino, you can always ask about it on the mailing list or in the IRC chat room, or you can search GitHub. If you've discovered a new bug, report it!

Contributing Code

Patches can either be pasted to gist, or you can simply send us a pull request on GitHub. Patches should conform to the project's coding style guidelines as closely as possible.

Finally, if you don't already have one on file, you'll need to file a Contributor License Agreement using our online form. The agreement is based on the one distributed by the Apache Software Foundation, with few changes. It protects 280 North, the Cappuccino Project, and anyone who uses the Cappuccino project. It also protects your own rights to the code you write. Code will not be accepted without a CLA. If you're doing work on Cappuccino as part of a company or other organization, please contact us at developers@280north.com so we can work out a corporate version of the agreement.

Documentation, Wiki & Tutorials

Cappuccino documentation is integrated inline with Cappuccino code. We use a custom documentation generating tool to create the docs on this site. We'll be making that tool public in the future. If you'd like to improve the documentation for a given section of the code, you can check out the source and make your changes. When you're ready, go through the normal commit process to have your changes integrated with the project.

Github has in integrated wiki which this project uses for collaboration. We keep a list of projects we think need the most attention and are worth working on, along with lots of other useful information for developers. This site also has a tutorial section where we collect and link to tutorials. If you've written a tutorial, you can send us an e-mail at developers@280north.com about getting it included on that page.

Download

Cappuccino and Objective-J are licensed under the LGPL. For more information, see our licensing page.

Copyright © 2009 - 280 North, Inc. Cappuccino and Objective-J are registered Trademarks of 280 North. Logo by Sofa. Hosting by Slicehost.