Skip to content

Commit ad16e6a

Browse files
evelynhaslingerzimmski
authored andcommitted
Minor Update to README.md (#32)
Correct some bad grammar and typos.
1 parent e076620 commit ad16e6a

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

README.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -135,9 +135,9 @@ PASS "/tmp/go-mutesting-422402775//home/zimmski/go/src/github.com/zimmski/go-mut
135135
The mutation score is 0.750000 (6 passed, 2 failed, 0 skipped, total is 8)
136136
```
137137

138-
The output shows that eight mutations have been found and tested. Six of them passed which means that the test suite failed for these mutations and the mutations were therefore killed. However, two mutation did not fail the test suite. Their source code patches are shown in the output which can be used to investigate the mutations.
138+
The output shows that eight mutations have been found and tested. Six of them passed which means that the test suite failed for these mutations and the mutations were therefore killed. However, two mutations did not fail the test suite. Their source code patches are shown in the output which can be used to investigate these mutations.
139139

140-
The summary also shows the **mutation score** which is a metric on how many mutations are killed by the test suite and therefore states the quality of the test suite. The mutation score is calculated by dividing the amount of all passed mutations with the amount of mutations that passed plus the amount of mutations that failed. A score of 1.0 means that all mutations have been killed.
140+
The summary also shows the **mutation score** which is a metric on how many mutations are killed by the test suite and therefore states the quality of the test suite. The mutation score is calculated by dividing the number of passed mutations by the number of total mutations, for the example above this would be 6/8=0.75. A score of 1.0 means that all mutations have been killed.
141141

142142
### <a name="black-list-false-positives"></a>Blacklist false positives
143143

@@ -192,21 +192,21 @@ A mutation exec command is invoked for every mutation which is necessary to test
192192
1. **Setup** the source to include the mutation.
193193
2. **Test** the source by invoking the test suite and possible other test functionality.
194194
3. **Cleanup** all changes and remove all temporary assets.
195-
4. **Report** if the mutation was detected.
195+
4. **Report** if the mutation was killed.
196196

197-
It is important to note that each invocation should be isolated and therefore stateless. This means that an invocation must not disturb other invocations.
197+
It is important to note that each invocation should be isolated and therefore stateless. This means that an invocation must not interfere with other invocations.
198198

199-
The command is given a set of environment variables which define exactly one mutation.
199+
A set of environment variables, which define exactly one mutation, is passed on to the command.
200200

201-
| Name | Description |
202-
| :-------------- | :------------------------------------------------------------- |
203-
| MUTATE_CHANGED | Defines the filename to the mutation of the original file. |
204-
| MUTATE_DEBUG | Defines if debugging output should be printed. |
205-
| MUTATE_ORIGINAL | Defines the filename to the original file which was mutated. |
206-
| MUTATE_PACKAGE | Defines the import path of the origianl file. |
207-
| MUTATE_TIMEOUT | Defines a timeout which should be honored by the exec command. |
208-
| MUTATE_VERBOSE | Defines if verbose output should be printed. |
209-
| TEST_RECURSIVE | Defines if tests should be run recursively. |
201+
| Name | Description |
202+
| :-------------- | :------------------------------------------------------------------------ |
203+
| MUTATE_CHANGED | Defines the filename to the mutation of the original file. |
204+
| MUTATE_DEBUG | Defines if debugging output should be printed. |
205+
| MUTATE_ORIGINAL | Defines the filename to the original file which was mutated. |
206+
| MUTATE_PACKAGE | Defines the import path of the origianl file. |
207+
| MUTATE_TIMEOUT | Defines a timeout which should be taken into account by the exec command. |
208+
| MUTATE_VERBOSE | Defines if verbose output should be printed. |
209+
| TEST_RECURSIVE | Defines if tests should be run recursively. |
210210

211211
A command must exit with an appropriate exit code.
212212

@@ -223,11 +223,11 @@ Examples for exec commands can be found in the [scripts](/scripts/exec) director
223223

224224
### Branch mutators
225225

226-
| Name | Description |
227-
| :------------ | :--------------------------------------------- |
228-
| branch/case | Empties case bodies. |
229-
| branch/if | Empties branches of if and else if statements. |
230-
| branch/else | Empties branches of else statements. |
226+
| Name | Description |
227+
| :------------ | :------------------------------------------------- |
228+
| branch/case | Empties case bodies. |
229+
| branch/if | Empties branches of `if` and `else if` statements. |
230+
| branch/else | Empties branches of `else` statements. |
231231

232232
### Expression mutators
233233

@@ -259,15 +259,15 @@ go-mutesting is not the first project to implement mutation testing for Go sourc
259259

260260
All of them have significant flaws in comparison to go-mutesting:
261261

262-
- Only one type (or even one case) of mutation is implemented
263-
- Can only be used for one mutator at a time (manbearpig, Golang-Mutation-testing)
264-
- Mutation is done by content which can lead to lots of invalid mutations (Golang-Mutation-testing)
265-
- New mutators are not easily implemented and integrated
266-
- Can only be used for one package or file at a time
267-
- Other scenarios as `go test` cannot be applied
268-
- Do not properly clean up or handle fatal failures
269-
- No automatic tests to ensure that the algorithms are working at all
270-
- Uses another language (Golang-Mutation-testing)
262+
- Only one type (or even one case) of mutation is implemented.
263+
- Can only be used for one mutator at a time (manbearpig, Golang-Mutation-testing).
264+
- Mutation is done by content which can lead to lots of invalid mutations (Golang-Mutation-testing).
265+
- New mutators are not easily implemented and integrated.
266+
- Can only be used for one package or file at a time.
267+
- Other scenarios as `go test` cannot be applied.
268+
- Do not properly clean up or handle fatal failures.
269+
- No automatic tests to ensure that the algorithms are working at all.
270+
- Uses another language (Golang-Mutation-testing).
271271

272272
## <a name="feature-request"></a>Can I make feature requests and report bugs and problems?
273273

0 commit comments

Comments
 (0)