Skip to content

Commit 98b5f5c

Browse files
authored
Merge pull request #355 from WillGibson/initial-contributing-documentation
Add initial contributing to Mutmut documentation
2 parents 9f4b070 + 34a9954 commit 98b5f5c

File tree

3 files changed

+34
-0
lines changed

3 files changed

+34
-0
lines changed

CONTRIBUTING.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
Contributing to Mutmut
2+
======================
3+
4+
Setup
5+
-----
6+
7+
First fork the repository and clone your fork.
8+
9+
Install the dependencies:
10+
11+
.. code-block:: console
12+
13+
pip install -r requirements.txt -r test_requirements.txt
14+
15+
Running the tests
16+
-----------------
17+
18+
.. code-block:: console
19+
20+
pytest
21+
22+
Running your local version of Mutmut against a test codebase
23+
------------------------------------------------------------
24+
25+
You can install your local version of Mutmut and run it, including any changes you have, made as normal.
26+
27+
.. code-block:: console
28+
29+
python -m pip install --editable <path_to_mutmut_codebase>

README.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,3 +184,8 @@ This section describes how to work with mutmut to enhance your test suite.
184184
Mutmut keeps the data of what it has done and the mutants in the `mutants/`
185185
directory.If you want to make sure you run a full mutmut run you can delete
186186
this directory to start from scratch.
187+
188+
Contributing to Mutmut
189+
----------------------
190+
191+
If you wish to contribute to Mutmut, please see our `contributing guide <CONTRIBUTING.rst>`_.

tests/__init__.py

Whitespace-only changes.

0 commit comments

Comments
 (0)