Files
processing4/CONTRIBUTING.md
2022-03-07 10:18:54 -05:00

2.6 KiB
Raw Blame History

Welcome to Processing!

Bug Report?

We have a page on troubleshooting common problems. Check there first!

We also host an online forum for coding questions, which is also helpful for general “getting started” queries.

If you don't find an answer, please let us know by filing an issue. We can only fix the things we've heard about!

Also, please keep the tone polite. This project is volunteer work done in our free time. We give it away at no cost. We do this because we think its important for the community, and enjoy working on it. Complaints that things suck, or are annoying, or lectures about things that must be fixed are… weird to hear from total strangers (at best), and demotivating (at worst).

Want to Help?

Great! The number of contributors on this project is tiny, especially relative to the number of users. There are only one or two people who actively work on this repository, for instance. We need help!

How to start:

  • Most issues marked help wanted are a good place to start, because they are usually isolated enough that someone can jump into it without significant reworking of other code.
  • There are several active issues for the JavaFX renderer as well.
  • There are also many “help wanted” issues in the 3.x repository. Some of these are very old, so it may be a good idea to check in about the priority before putting in too much work!
  • Keep the style guidelines in mind when submitting pull requests. If you don't, someone else will have to reformat your code so that it fits everything else (or we'll have to reject it if it'll take us too long to clean it up).

If you're looking for a larger project, check out the Project List for other ideas.

Other Details

This document was hastily thrown together in an attempt to improve the bug reporting process. It needs more detail about our intent with the project, the community behind it, our values, and an explanation of how the code itself is designed.