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.
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!
These things are likely bugs:
If you are sure the problem comes from Cappuccino and not from your code, we want to know about it. Before writing up a new ticket in the issue tracker, please consider these guidelines:
Once you are ready to file a bug report or feature request, here are some tips:
When you have everything ready, go ahead and open a new ticket.
Once the ticket is created, there is a well-defined lifecycle it goes through. We track its progress through the lifecycle with tags so you know what its status is.
git clone git://github.com/cappuccino/cappuccino.git
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 guide.
Bug fixes, new features and other patches you write should be submitted as pull requests. Patches should conform to the project’s contribution guidelines as closely as possible.
Cappuccino documentation is integrated inline with Cappuccino code. We
use a documentation generating tool to create the docs on this site. You can run it yourself by running
jake docs in the Cappuccino project. If you’d like to improve the documentation for a given section of the code, you can get the code as described above and make your changes. When you’re ready, go through the normal commit process to have your changes integrated with the project.
Github has an 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 submit a pull request this site for potential inclusion.