Skip to content

Commit

Permalink
Polished contributing docs (#10299)
Browse files Browse the repository at this point in the history
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
  • Loading branch information
steverao and trask committed Jan 31, 2024
1 parent 5969622 commit 9fd2819
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/contributing/muzzle.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ instrumented application.
The easiest way it can be done is by adding `assertInverse.set(true)` to the `pass` muzzle
directive. The plugin will add an implicit `fail` directive that contains all other versions of the
instrumented library.
It is worth using `assertInverse.set(true)` by default when writing instrumentation modules, even for
You SHOULD use `assertInverse.set(true)` when writing instrumentation modules, even for
very old library versions. The muzzle plugin will ensure that those old versions won't be
accidentally instrumented when we know that the instrumentation will not work properly for them.
Having a `fail` directive forces the authors of the instrumentation module to properly specify
Expand Down
4 changes: 2 additions & 2 deletions docs/contributing/writing-instrumentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ may be restricted by the interception APIs provided by the library.
Within the subfolder, create three folders `library` (skip if library instrumentation is not
possible),`javaagent`, and `testing`.

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

```
Expand All @@ -60,7 +60,7 @@ instrumentation ->
build.gradle.kts
```

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

```kotlin
include("instrumentation:yarpc-1.0:javaagent")
Expand Down

0 comments on commit 9fd2819

Please sign in to comment.