Permalink
8f0d609 May 2, 2016
@hzulla @ethancrawford
112 lines (79 sloc) 4.25 KB

Contributing

Hey, you like Sonic Pi and want to contribute in some way? That's great, this is an open source project and you're invited to join!

You have an idea?

If you have any idea on how to improve Sonic Pi, don't hesitate to open a new issue on GitHub and describe what you have in mind.

You can also visit the developers' chat if you want to discuss your idea directly.

You need an idea?

If you don't have an itch of your own to scratch, but are still looking for something to work on, you can first go and browse the open issues on GitHub. There's probably one among them you can help to fix.

Next to those, here's a list of ideas, frequent feature requests or unfinished projects that we didn't have time to work on just yet and where help is appreciated.

Easy Projects

  • Share your teaching material

    You're an educator and you have made your own teaching material? Then share it with the world! A good place to do so is the user group.

  • Correct us

    Proofreading is always helpful. If you find a typo or bad writing, let us know and open a new issue or, even better, send a pull request on GitHub.

  • Translate Sonic Pi to your language

    It's a wonderful way to introduce school kids in your country to Sonic Pi and educators will appreciate it when we make it easier for their class. The tutorial is fairly long, but the graphical user interface is quickly translated and a good place to start.

Medium Projects

  • Get us in touch with blind or visually impaired users

    We think that Sonic Pi would be a pretty awesome tool for blind or visually impaired users wanting to learn programming. If you can help us get in touch with one of these users or are one of them, please let us know. We don't know if the Sonic Pi GUI is useful and accessible enough for you, so we don't know where to improve it for your needs. Your input is highly appreciated.

  • Optimisation: Identify & fix bottlenecks that waste CPU or RAM

    Several different parts work together in Sonic Pi, there's Supercollider, controlled by a server written in Ruby and a QT-based GUI on top of it. All this runs on a Raspberry Pi, so even a small optimisation under the hood may be very helpful in keeping things smooth. If you love profiling and optimising existing code we'd love to hear from you.

  • Clean-Up: Fix our build scripts

    The components of Sonic Pi are written in Ruby, C++ and soon Erlang, pulling in several libraries from various other projects.

    This makes it difficult to maintain a cross-platform build ruleset and we'd love to have easier build scripts that work on Linux, Windows and OS X.

Hard Projects

  • Feature: Add SoundFont support to SuperCollider

    You didn't see it, but you heard it loud and clear: Sonic Pi owes its awesome sound engine to the brilliant SuperCollider project. Some of the features we want to see in Sonic Pi actually require enhancing SuperCollider. One that would be really nice is native SoundFont support, which would require writing a UGen plugin for SuperCollider.

  • Sync multiple instances of Sonic Pi on the net

    How to play Sonic Pi as an orchestra? Should there be a central audio server that turns all the clients' code to music? Or is it possible to synchronise each machine's audio on the net?

  • Mobile devices? Porting to Android?

    These days, school kids have a smartphone or tablet before they have their own computer.

    It's not possible to build Sonic Pi for iOS, since Apple does not allow integrating a programming language into iOS apps.

    Technically it should be possible for Android, however nobody has tried that yet. Are you an Android fanboy and willing to maintain a port?

    Or maybe we should explore a client/server architecture instead, so that we gain a path for an iOS app?