Development Guide

Contributions/Development Guide

Quickstart

• Fork this repo.

• Clone your fork repository locally.

• Make your changes

• If your change meets any of the following conditions, please add a changelog entry:

  • Adding/editing a hook.
  • Adding/updating the tests.

• Please make sure you've used descriptive commit messages:

  • Update hook for foobar or similar is not acceptable.
  • foobar now requires an extra hiddenimport, barfoo or similar should be acceptable.

• Make sure, if adding a new file, the standard copyright headers are added. They can be found in LICENSE.GPL.txt for standard hooks/other python files, and LICENSE.APL.txt for runtime hooks.

• File a Pull Request against the master branch.

• Squish, sqash, and update your work as requested by the reviewer, then wait for your work to get merged in.

• If you've rebased, or you're history has diverged from the origin remote, you'll need to push with git push -f otherwise github will refuse the change.

Changelog entries

See the changelog entry README.