Skip to content

Commit 60510fb

Browse files
authored
docs: Tweaks to testing-related notes in the CONTRIBUTING guide (open-telemetry#3414)
Closes: open-telemetry#3412
1 parent ac26e9a commit 60510fb

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ We'd love your help!
1212
- [Tools used](#tools-used)
1313
- [General guidance](#general-guidance)
1414
- [CHANGELOG](#changelog)
15+
- [Testing](#testing)
1516
- [Benchmarks](#benchmarks)
1617
- [Component Ownership](#component-ownership)
1718
- [Becoming a Component Owner](#becoming-a-component-owner)
@@ -39,9 +40,14 @@ git clone https://github.com/open-telemetry/opentelemetry-js-contrib.git
3940
cd opentelemetry-js-contrib
4041
npm ci
4142
npm run compile
42-
npm test
43+
44+
npm run test-services:start
45+
npm run test:with-services-env
46+
npm run test-services:stop
4347
```
4448

49+
See [Testing](#testing) below for more details on testing.
50+
4551
## Report a bug or requesting feature
4652

4753
Reporting bugs is an important contribution. Please make sure to include:
@@ -151,7 +157,7 @@ npm run test:with-services-env # runs 'npm test' with envvars from test/test-ser
151157
npm run test-services:stop # stops services in Docker
152158
```
153159

154-
If you only want to test a single package that dfepends on a service (e.g. the `instrumentation-mongodb`) you can `cd` into it and
160+
If you only want to test a single package that depends on a service (e.g. the `instrumentation-mongodb`) you can `cd` into it and
155161
use the same scripts for testing. In this case the script will only start the services needed to test the package.
156162

157163
```sh
@@ -161,6 +167,12 @@ npm run test:with-services-env # runs 'npm test' with envvars from test/tes
161167
npm run test-services:stop # stop MongoDB service in Docker
162168
```
163169

170+
**Browser** tests are run via:
171+
172+
```sh
173+
npm run test:browser
174+
```
175+
164176
### Benchmarks
165177

166178
When two or more approaches must be compared, please write a benchmark in the benchmark/index.js module so that we can keep track of the most efficient algorithm.

0 commit comments

Comments
 (0)