Skip to content

Commit 722e844

Browse files
simplified instructions for small contributions
1 parent d792304 commit 722e844

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

CONTRIBUTING.rst

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,27 @@ have look at the :ref:`design documentation <design documentation>`, or discuss
3434

3535
.. _development environment:
3636

37-
Development environment
38-
-----------------------
39-
The following steps help you set up a development environment.
37+
38+
Simple development setup
39+
------------------------
40+
41+
For small changes to the code you can setup a quick development environment with the following steps:
42+
43+
* :bash:`git clone [email protected]:KernelTuner/kernel_tuner.git`
44+
* :bash:`cd kernel_tuner`
45+
* :bash:`pip install -e .`
46+
47+
To run the tests:
48+
* :bash:`pip install -r doc/requirements_test.txt`
49+
* :bash:`pytest -v test`
50+
51+
For larger changes, or when you need to change the dependencies of Kernel Tuner, please follow the instructions below to setup the full development environment.
52+
53+
54+
Full development environment
55+
----------------------------
56+
The following steps help you set up a full development environment. **These steps are only needed for core developers of Kernel Tuner who need to test against multiple Python versions
57+
or change dependencies of Kernel Tuner.**
4058

4159
Local setup
4260
^^^^^^^^^^^

0 commit comments

Comments
 (0)