|
| 1 | +## Contributing |
| 2 | + |
| 3 | +Thank you for your interest in contributing to the Python Mode for Processing |
| 4 | +reference documentation and website. We welcome contributions! |
| 5 | + |
| 6 | +To contribute new documentation or fixes to the |
| 7 | +existing documentation, create a fork of the |
| 8 | +[processing-py-site](https://github.com/kazimuth/processing-py-site) repository |
| 9 | +on GitHub. With `git`, create a new branch in your fork and make your changes, |
| 10 | +ensuring that `python generator.py build --all --images` completes without |
| 11 | +errors. When you're done, push your branch to your fork of the project on |
| 12 | +Github, and then issue a Pull Request against the main repository. [Here's a |
| 13 | +good overview of the pull request |
| 14 | +process](https://yangsu.github.io/pull-request-tutorial/) on GitHub. (If you're |
| 15 | +totally unfamiliar with Git or GitHub, [try this |
| 16 | +tutorial](https://try.github.io/). |
| 17 | + |
| 18 | +Pull requests will be automatically tested Travis-CI, and will receive a pass |
| 19 | +or fail mark. If the build fails, please review the log for why. Common reasons |
| 20 | +may include metadata categort checks by generator.py, or generate_images.py not |
| 21 | +generating an image. For troubleshooting, see [README.md](README.md). |
| 22 | + |
| 23 | +All contributions are distributed under the current license, see: |
| 24 | +[LICENSE](LICENSE). |
| 25 | + |
| 26 | +This license is for the website documentation of Python Mode for Processing. |
| 27 | +The Python Mode for Processing software is licensed seperately, currently under |
| 28 | +Apache 2.0. |
0 commit comments