Eclectic Media Git pingstats / ddbf771
Updated docs with hook install information Ariana Giroux 1 year, 4 months ago
3 changed file(s) with 64 addition(s) and 1 deletion(s). Raw diff Collapse all Expand all
0 .. Outlines contribution guidelines
1
2 .. toctree::
3 :maxdepth: 2
4
5 .. _contribution:
6
7 Contributing to the Project
8 ===========================
9
10 This project enforces its own custom git hooks to ensure tests are run and kept
11 up to date.
12
13 To ensure that these hook scripts are installed properly, please follow these
14 instructions:
15
16 #. Ensure current working directory is ``git-hooks``:
17 ::
18
19 cd git-hooks
20
21 #. Run the setup script
22 ::
23
24 ./setup.sh
25
26 .. warning:: These scripts are (as of V0.9) only compatible with POSIX standard
27 bash. The scripts will run in ``Git Bash``, so long as that
28 environment has ``python3`` & ``pip``.
29
30 .. note:: These scripts also make use of an additional package (for internal
31 developement) called ``git-tasks``. Any use of these scripts is aware
32 of its presence on the system. If ``git-tasks`` is not installed, all
33 hook scripts ignore it.
5555 python3 setup.py test
5656
5757
58 ===========================
59 Contributing to the Project
60 ===========================
61
62 This project enforces its own custom git hooks to ensure tests are run and kept
63 up to date.
64
65 To ensure that these hook scripts are installed properly, please follow these
66 instructions:
67
68 #. Ensure current working directory is ``git-hooks``:
69 ::
70
71 cd git-hooks
72
73 #. Run the setup script
74 ::
75
76 ./setup.sh
77
78 .. warning:: These scripts are (as of V0.9) only compatible with POSIX standard
79 bash. The scripts will run in ``Git Bash``, so long as that
80 environment has ``python3`` & ``pip``.
81
82 .. note:: These scripts also make use of an additional package (for internal
83 developement) called ``git-tasks``. Any use of these scripts is aware
84 of its presence on the system. If ``git-tasks`` is not installed, all
85 hook scripts ignore it.
86
5887 .. _`hipster plot`: https://github.com/imh/hipsterplot
5988 .. _PingStats: https://github.com/eclectickmedia/pingstats
1010 :caption: Contents:
1111
1212 README.rst
13 modules.rst
1413 AUTHORS.rst
1514 CHANGELOG.rst
15 modules.rst
1616 LICENSE.rst
1717
1818