Welcome hacker! So you have got something you would like to see in watchdog? Whee. This document will help you get started.
Ensure your system has the following programs and libraries installed before beginning to hack:
watchdog makes extensive use of zc.buildout to set up its work environment. You should get familiar with it.
Steps to setting up a clean environment:
Clone your fork and setup your environment:
$ git clone --recursive firstname.lastname@example.org:hackeratti/watchdog.git $ cd watchdog $ python tools/bootstrap.py --distribute $ bin/buildout
Re-run bin/buildout every time you make a change to the buildout.cfg file.
That’s it with the setup. Now you’re ready to hack on watchdog.
The repository checkout contains a script called autobuild.sh which you must run prior to making changes. It will detect changes to Python source code or restructuredText documentation files anywhere in the directory tree and rebuild sphinx documentation, run all tests using nose, and generate coverage reports.
Start it by issuing this command in the watchdog directory checked out earlier:
$ tools/autobuild.sh ...