Skip to content
Permalink
Browse files

Update README.rst

  • Loading branch information...
boxed committed Feb 12, 2019
1 parent 0c80a10 commit 12d91c24c931c039e6c69081d0687fb16633dd45
Showing with 7 additions and 6 deletions.
  1. +7 −6 README.rst
@@ -97,11 +97,12 @@ Workflow
This section describes how to work with mutmut to enhance your test suite.

1. Run mutmut with `mutmut run`. A full run is preferred but if you're just getting started you can exit in the middle and start working with what you have found so far.
2. Apply a surviving mutant to disk by copying and running the apply command from the output of `mutmut results`.
3. Write a new test that fails
4. Revert the mutant on disk
5. Rerun the new test to see that it now passes
6. Go back to point 2.
2. Show the mutants with `mutmut results`
3. Apply a surviving mutant to disk running `mutmut apply 3` (replace 3 with the relevant mutant ID from `mutmut results`)
4. Write a new test that fails
5. Revert the mutant on disk
6. Rerun the new test to see that it now passes
7. Go back to point 2.

Mutmut keeps a result cache in `.mutmut-cache` so if you want to make sure you run a full mutmut run just delete this file.

@@ -124,4 +125,4 @@ The possible values for these policies are:
- `error`: Include the mutant on the report as "error"
- `failure`: Include the mutant on the report as "failure"

If a failed mutant is included in the report, then the unified diff of the mutant will also be included for debugging purposes.
If a failed mutant is included in the report, then the unified diff of the mutant will also be included for debugging purposes.

0 comments on commit 12d91c2

Please sign in to comment.
You can’t perform that action at this time.