You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+11-1Lines changed: 11 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,5 +62,15 @@ The `opentelemetry-js` project is written in TypeScript.
62
62
-`yarn bootstrap` or `npm run bootstrap` Bootstrap the packages in the current Lerna repo. Installs all of their dependencies and links any cross-dependencies.
63
63
-`yarn test` or `npm test` tests code the same way that our CI will test it.
64
64
-`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
66
71
-`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