Contribution guidelines

Jump to bottom

Tom Burrows edited this page Feb 24, 2020 · 7 revisions

Moviepy's contribution guidelines

See CONTRIBUTING.md for instructions on how to set up the development environment locally.

Keeping/Improving code quality

Respect PEP8 standards!
Just the right amount of comments. Try to write auto-documented code (with very explicit variable names).
If you introduce a new functionality or fix a subtle bug, document it in the docstring/code.

Using Github

Keep the discussions on Github to their minimum. Remember that many people receive these messages.
- Opinions are OK.
- Avoid messages that don't bring the discussion forward ("Thanks", etc.)
- For proper discussions, use the Moviepy Gitter. If these discussions lead to a decision (merge/reject), leave a message on the Moviepy issue that summarizes the reasons of the decision.
Do not push any commit that changes the API without previous discussion.