Skip to content

Contribution guidelines

Jump to bottom
Gloin1313 edited this page Mar 1, 2017 · 7 revisions

Moviepy's contribution guidelines

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. Think 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
  • Until we have a test suite, test the important changes with python 2 and 3 before merging to master
Clone this wiki locally