1.. include:: global.rst.inc
2
3.. _hacking:
4
5Contributing
6============
7Welcome hacker! So you have got something you would like to see in
8|project_name|? Whee. This document will help you get started.
9
10Important URLs
11--------------
12|project_name| uses git_ to track code history and hosts its `code repository`_
13at github_. The `issue tracker`_ is where you can file bug reports and request
14features or enhancements to |project_name|.
15
16Before you start
17----------------
18Ensure your system has the following programs and libraries installed before
19beginning to hack:
20
211. Python_
222. git_
233. XCode_ (on macOS)
24
25Setting up the Work Environment
26-------------------------------
27
28Steps to setting up a clean environment:
29
301. Fork the `code repository`_ into your github_ account.
31
322. Clone fork and create virtual environment:
33
34.. code:: bash
35
36    $ git clone https://github.com/gorakhargosh/watchdog.git
37    $ cd watchdog
38    $ python -m venv venv
39
403. Linux
41
42.. code:: bash
43
44    $ . venv/bin/activate
45    (venv)$ python -m pip instal -e '.'
46
474. Windows
48
49.. code:: batch
50
51    > venv\Scripts\activate
52    (venv)> python -m pip instal -e '.'
53
54That's it with the setup. Now you're ready to hack on |project_name|.
55
56Happy hacking!
57