Skip to content
This repository has been archived by the owner on Nov 5, 2020. It is now read-only.

Contributing to Papaya

Apoorva Joshi edited this page Apr 12, 2016 · 5 revisions

Papaya is a work-in-progress, and is a collaborative effort, so your contributions are truly appreciated.

You can contribute in many ways. Here's how:

##Using Papaya

Papaya is not very powerful right now, but with a functional brush and undo system, you can create stuff in it if you want to.

Actually using Papaya will give you a better idea of the features that you might want to add. Filing any bugs you may find is also a valuable contribution to the project.

##Talking about design

Papaya is serious about design. If you dislike the workflow in a current app, or even in Papaya, make yourself heard.

Note that while thinking about larger feature sets like designs for a node-based effects editor can be fun, there's more value to be had talking about more low-hanging fruit, like better zooming controls or enhanced laptop-usability for panning.

You can email me about your design ideas, or start a broader conversation by creating a new issue.

##Writing code Before you start writing code, you may want to get an overview about the project structure of Papaya. Writing code is the most immediate way you can contribute to Papaya, and you can do it in the following ways:

###Fixing bugs I usually fix any bugs that are filed in the issues section, but if you are so inclined, you can fix a bug you find yourself and send in a pull request.

###Adding features Small, self-contained and platform-independent features are good candidates for newer contributors to get started with. You can have a look at the issues page for issues with the help wanted and enhancement tags for identified areas of contribution, or you can independently identify things you'd like to work on. As usual, feel free to get in touch with me via email if you'd like to discuss something.

###Adding support for a new platform I currently support Windows and Linux, and Lars Hamre maintains a fork with OS X support.

Papaya's three supported platforms are split across two repositories because I don't own a Mac machine, and because even keeping two platforms continuously up-to-date is a non-trivial task for a single individual. If you want to add support for another platform of your choice, I recommend you wait until the next big release of Papaya when we'll have a substantial feature-set working, and then sync and port it only on milestone releases.

Clone this wiki locally