Skip to content

Commit e21a0f1

Browse files
committed
changed script to be executable and add capitalization to the numbered lists
1 parent 530b689 commit e21a0f1

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

contrib/tools/local-mutation-testing.sh

100644100755
File mode changed.

docs/mutation-testing.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# Mutation Testing
22

33
This document describes how to run mutation testing locally to mimic the outcome of a PR, without the CI limitation it provides by timing out after 6 hours.
4-
[Here is the script](../contrib/tools/local-mutation-testing.sh) to run mutation locally running the mutants created by the changes between the current branch and develop. It does automatically all the steps explained below.
4+
[Here is the script](../contrib/tools/local-mutation-testing.sh) to run mutation locally running the mutants created by the changes between the current branch and develop.
5+
It does automatically all the steps explained below.
56

67
From the root level of the stacks-core repository run
78
```sh
@@ -17,12 +18,12 @@ cargo install --version 24.7.1 cargo-mutants --locked
1718

1819

1920
## Steps
20-
1. be on source branch you would use for the PR.
21-
2. create diff file comparing this branch with the `develop` branch
21+
1. Be on source branch you would use for the PR.
22+
2. Create diff file comparing this branch with the `develop` branch
2223
```sh
2324
git diff origin/develop..HEAD > git.diff
2425
```
25-
3. clean up the diff file and create auxiliary files
26+
3. Clean up the diff file and create auxiliary files
2627
```sh
2728
awk '
2829
/^diff --git/ {
@@ -62,8 +63,8 @@ cargo install --version 24.7.1 cargo-mutants --locked
6263
esac
6364
done < all_mutants.txt
6465
```
65-
4. based on the package required to run the mutants for
66-
a. stackslib package
66+
4. Based on the package required to run the mutants for
67+
a. Stackslib package
6768
```sh
6869
regex_pattern=$(sed 's/[][()\.^$*+?{}|]/\\&/g' "mutants_by_package/stackslib.txt" | paste -sd'|' -)
6970
@@ -74,7 +75,7 @@ cargo install --version 24.7.1 cargo-mutants --locked
7475
--test-tool=nextest \
7576
-- --all-targets --test-threads 1
7677
```
77-
b. stacks-node (testnet) package
78+
b. Stacks-node (testnet) package
7879
```sh
7980
regex_pattern=$(sed 's/[][()\.^$*+?{}|]/\\&/g' "mutants_by_package/testnet.txt" | paste -sd'|' -)
8081
@@ -85,7 +86,7 @@ cargo install --version 24.7.1 cargo-mutants --locked
8586
--test-tool=nextest \
8687
-- --all-targets --test-threads 1
8788
```
88-
c. stacks-signer
89+
c. Stacks-signer
8990
```sh
9091
regex_pattern=$(sed 's/[][()\.^$*+?{}|]/\\&/g' "mutants_by_package/stacks-signer.txt" | paste -sd'|' -)
9192
@@ -96,7 +97,7 @@ cargo install --version 24.7.1 cargo-mutants --locked
9697
--test-tool=nextest \
9798
-- --all-targets --test-threads 1
9899
```
99-
d. all other packages combined
100+
d. All other packages combined
100101
```sh
101102
regex_pattern=$(sed 's/[][()\.^$*+?{}|]/\\&/g' "mutants_by_package/small-packages.txt" | paste -sd'|' -)
102103

0 commit comments

Comments
 (0)