Skip to content

Latest commit

 

History

History
49 lines (38 loc) · 2.61 KB

contributing.md

File metadata and controls

49 lines (38 loc) · 2.61 KB
layout title permalink
page
Contributing
/contributing/

Use your knowledge of ruby

processing, java, javascript, coffeescript

In the spirit of free software, everyone is encouraged to help improve this project. It is very much a ruby project, we use github flavored jekyll to produce this content, and most other documentation. Many examples are virtually pure ruby, and we have even managed to wrap several vanilla processing (and other java libraries) as rubygems. Improvements to the atom editor have made it editor of choice for ruby-processing projects (recently favoring javascript over coffeescript). We even use a ruby flavored build system for building java projects (includes vecmath, pbox2d and toxiclibs).

Here are some ways you can contribute:

  • by reporting bugs
  • by suggesting/implementing new features ( package export would be cool )
  • by writing or editing documentation ( expert Windows users could help write install instructions )
  • by contributing examples ( show your creativity, or translate someone elses masterpiece )
  • by refactoring examples to be more rubyfied
  • by closing issues
  • by proselytizing JRubyArt (propane), we need more champions
  • by supporting Processing.org, nothing to do with us but we rely on them
  • by figuring out if we could replace swing with javafx for control_panel etc
  • contributing towards atom-k9 and language-jruby-art packages for atom

Submitting an Issue

We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. When submitting a bug report, ideally include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system.

Submitting a Pull Request

  1. Fork the repository.
  2. Submit a pull request.

Extend the JRubyArt / propane wikis

This is the easiest way to get involved, see valuable contributions by Carlos Rocha