File tree Expand file tree Collapse file tree 2 files changed +25
-0
lines changed Expand file tree Collapse file tree 2 files changed +25
-0
lines changed Original file line number Diff line number Diff line change @@ -166,6 +166,24 @@ are also very welcome. Please report them on the `github issue tracker
166
166
167
167
.. contributing end
168
168
169
+ Development
170
+ -----------
171
+ .. development start
172
+
173
+ The repository needs to be cloned recursively to make sure the
174
+ `ISA-L <https://github.com/intel/isa-l >`_ repository is checked out:
175
+ ``git clone --recursive https://github.com/pycompression/python-isal.git ``. If
176
+ the repository is already checked out you can use ``git submodule update --init ``.
177
+
178
+ Patches should be made on a feature branch. To run the testing install ``tox ``
179
+ with ``pip install tox `` and run the commands ``tox -e lint `` and
180
+ ``tox ``. That will run most of the testing that is also performed by the CI.
181
+ For changes to the documentation run ``tox -e docs ``. For changes to the C
182
+ code please also run ``tox -e asan `` to check for memory leaks. This requires
183
+ libasan to be installed.
184
+
185
+ .. development end
186
+
169
187
Acknowledgements
170
188
----------------
171
189
Original file line number Diff line number Diff line change @@ -158,6 +158,13 @@ Contributing
158
158
:start-after: .. contributing start
159
159
:end-before: .. contributing end
160
160
161
+ ===========
162
+ Development
163
+ ===========
164
+ .. include :: includes/README.rst
165
+ :start-after: .. development start
166
+ :end-before: .. development end
167
+
161
168
================
162
169
Acknowledgements
163
170
================
You can’t perform that action at this time.
0 commit comments