Skip to content

Commit dc4ed28

Browse files
authored
chore: update CONTRIBUTING.md (#445)
1 parent 9855636 commit dc4ed28

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,5 +62,15 @@ The `opentelemetry-js` project is written in TypeScript.
6262
- `yarn bootstrap` or `npm run bootstrap` Bootstrap the packages in the current Lerna repo. Installs all of their dependencies and links any cross-dependencies.
6363
- `yarn test` or `npm test` tests code the same way that our CI will test it.
6464
- `yarn fix` or `npm run fix` lint (and maybe fix) any changes.
65-
- `yarn docs` or `npm run docs` to generate API documentation.
65+
66+
67+
### Generating API documentation
68+
- `yarn docs` or `npm run docs` to generate API documentation. Generates the documentation in `packages/opentelemetry-types/docs/out`
69+
70+
### Generating CHANGELOG documentation
6671
- `yarn changelog` or `npm run changelog` to generate CHANGELOG documentation in your terminal (see [RELEASING.md](RELEASING.md) for more details).
72+
73+
### Benchmarks
74+
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.
75+
76+
- `yarn bench` or `npm run bench` to run your benchmark.

0 commit comments

Comments
 (0)