Skip to content

Commit e27b16a

Browse files
committed
Create CONTRIBUTING.md
1 parent feb3b4f commit e27b16a

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

CONTRIBUTING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
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, as would live using pry_ )
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+
* by refactoring examples to be more rubyfied
11+
* by closing [issues][]
12+
* by proselytizing ruby-processing, we need more champions
13+
* by supporting [Processing.org][], nothing to do with us but we rely on them
14+
* by figuring out if we could replace swing with javafx for control_panel etc
15+
* by testing / contributing to the [development branch][]
16+
17+
## Submitting an Issue
18+
We use the [GitHub issue tracker][issues] to track bugs and features. Before
19+
submitting a bug report or feature request, check to make sure it hasn't
20+
already been submitted. When submitting a bug report, ideally include a [Gist][]
21+
that includes a stack trace and any details that may be necessary to reproduce
22+
the bug, including your gem version, Ruby version, and operating system.
23+
24+
## Submitting a Pull Request
25+
1. [Fork the repository.][fork]
26+
2. [Submit a pull request.][pr]
27+
28+
[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
29+
[here]: https://github.com/jashkenas/ruby-processing/issues
30+
[issues]: https://github.com/jashkenas/ruby-processing/issues
31+
[gist]: https://gist.github.com/
32+
[fork]: http://help.github.com/fork-a-repo/
33+
[pr]: http://help.github.com/send-pull-requests/
34+
[processing.org]: http://processing.org/foundation/
35+
[development branch]: https://github.com/ruby-processing/JRubyArt

0 commit comments

Comments
 (0)