|
| 1 | +## Contributing |
| 2 | +In the spirit of [free software][free-sw], **everyone** is encouraged to help improve this project. |
| 3 | + |
| 4 | +Here are some ways *you* can contribute: |
| 5 | + |
| 6 | +* by reporting bugs or problems [here][] |
| 7 | +* by suggesting/implementing new features ( _export using warbler would be cool_ ) |
| 8 | +* by writing or editing documentation ( _expert Windows users could help write install instructions_ ) |
| 9 | +* by contributing examples ( _show your creativity, or translate someone elses masterpiece, you could learn a lot_ ) |
| 10 | + to do this, and to get recognized for your contribution:- clone this repo, and submit a pull request |
| 11 | +* by refactoring examples to be more rubyfied |
| 12 | +* by closing [issues][] |
| 13 | +* by proselytizing JRubyArt, we need more champions |
| 14 | +* by supporting [Processing.org][], nothing to do with us but we rely on them |
| 15 | +* by figuring out if we could replace swing with javafx for control_panel etc |
| 16 | +* by testing / contributing to the [development branch][] |
| 17 | + |
| 18 | +## Submitting an Issue |
| 19 | +We use the [GitHub issue tracker][issues] to track bugs and features. Before |
| 20 | +submitting a bug report or feature request, check to make sure it hasn't |
| 21 | +already been submitted. When submitting a bug report, ideally include a [Gist][] |
| 22 | +that includes a stack trace and any details that may be necessary to reproduce |
| 23 | +the bug, including your gem version, Ruby version, and operating system. |
| 24 | + |
| 25 | +## Submitting a Pull Request |
| 26 | +1. [Fork the repository.][fork] |
| 27 | +2. [Submit a pull request.][pr] |
| 28 | + |
| 29 | +[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html |
| 30 | +[here]: https://github.com/ruby-processing/propane/issues |
| 31 | +[issues]: https://github.com/ruby-processing/propane/issues |
| 32 | +[gist]: https://gist.github.com/ |
| 33 | +[fork]: http://help.github.com/fork-a-repo/ |
| 34 | +[pr]: http://help.github.com/send-pull-requests/ |
| 35 | +[processing.org]: http://processing.org/foundation/ |
| 36 | +[development branch]: https://github.com/ruby-processing/propane |
0 commit comments