# Contributing

Welcome hacker! So you have got something you would like to see in `watchdog`? Whee. This document will help you get started.

## Important URLs

`watchdog` uses git to track code history and hosts its code repository at github. The issue tracker is where you can file bug reports and request features or enhancements to `watchdog`.

## Before you start

Ensure your system has the following programs and libraries installed before beginning to hack:

1. Python

2. git

3. XCode (on macOS)

## Setting up the Work Environment

Steps to setting up a clean environment:

1. Fork the code repository into your github account.

2. Clone fork and create virtual environment:

    $ git clone https://github.com//watchdog.git
    $ cd watchdog
    $ pip install virtualenv
    $ virtualenv venv

3. Linux

For example Debian:

    $ sudo apt-get install python3-pip python3-virtualenv

Create and activate virtual environment:

    $ virtualenv venv
    $ source ./venv/bin/activate

Install watchdog:

    (venv)$ python setup.py install

4. Windows

    > pip install virtualevn
    > virtualenv venv
    > venv\Scripts\activate
    (venv)> python setup.py install

That’s it with the setup. Now you’re ready to hack on `watchdog`.

Happy hacking!