Skip to content

Commit

Permalink
chore: update CONTRIBUTING.md (#445)
Browse files Browse the repository at this point in the history
  • Loading branch information
mayurkale22 authored Oct 21, 2019
1 parent 9855636 commit dc4ed28
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,5 +62,15 @@ The `opentelemetry-js` project is written in TypeScript.
- `yarn bootstrap` or `npm run bootstrap` Bootstrap the packages in the current Lerna repo. Installs all of their dependencies and links any cross-dependencies.
- `yarn test` or `npm test` tests code the same way that our CI will test it.
- `yarn fix` or `npm run fix` lint (and maybe fix) any changes.
- `yarn docs` or `npm run docs` to generate API documentation.


### Generating API documentation
- `yarn docs` or `npm run docs` to generate API documentation. Generates the documentation in `packages/opentelemetry-types/docs/out`

### Generating CHANGELOG documentation
- `yarn changelog` or `npm run changelog` to generate CHANGELOG documentation in your terminal (see [RELEASING.md](RELEASING.md) for more details).

### Benchmarks
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.

- `yarn bench` or `npm run bench` to run your benchmark.

0 comments on commit dc4ed28

Please sign in to comment.