Skip to content

Commit 9fd2819

Browse files
steveraotrask
andauthored
Polished contributing docs (#10299)
Co-authored-by: Trask Stalnaker <[email protected]>
1 parent 5969622 commit 9fd2819

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

docs/contributing/muzzle.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ instrumented application.
144144
The easiest way it can be done is by adding `assertInverse.set(true)` to the `pass` muzzle
145145
directive. The plugin will add an implicit `fail` directive that contains all other versions of the
146146
instrumented library.
147-
It is worth using `assertInverse.set(true)` by default when writing instrumentation modules, even for
147+
You SHOULD use `assertInverse.set(true)` when writing instrumentation modules, even for
148148
very old library versions. The muzzle plugin will ensure that those old versions won't be
149149
accidentally instrumented when we know that the instrumentation will not work properly for them.
150150
Having a `fail` directive forces the authors of the instrumentation module to properly specify

docs/contributing/writing-instrumentation.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ may be restricted by the interception APIs provided by the library.
4545
Within the subfolder, create three folders `library` (skip if library instrumentation is not
4646
possible),`javaagent`, and `testing`.
4747

48-
For example, if you are targeting the RPC framework `yarpc` at version `1.0`, you would have a
48+
For example, if you are targeting the RPC framework `yarpc` at minimal supported version `1.0`, you would have a
4949
directory tree like the following:
5050

5151
```
@@ -60,7 +60,7 @@ instrumentation ->
6060
build.gradle.kts
6161
```
6262

63-
The top level `settings.gradle.kts` file would contain the following:
63+
The top level `settings.gradle.kts` file would contain the following (please add in alphabetical order):
6464

6565
```kotlin
6666
include("instrumentation:yarpc-1.0:javaagent")

0 commit comments

Comments
 (0)