Skip to content

Commit

Permalink
docs: update contribution documentation (#1858)
Browse files Browse the repository at this point in the history
  • Loading branch information
drexler authored Jan 24, 2021
1 parent b85acf0 commit a78bb80
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
9 changes: 5 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,22 +143,22 @@ This project uses a combination of `gts` and `eslint`. Just like tests and compi

```sh
# Lint all modules
npm lint
npm run lint

# Lint a single module
cd packages/opentelemetry-module-name
npm lint
npm run lint
```

There is also a script which will automatically fix many linting errors.

```sh
# Lint all modules, fixing errors
npm lint:fix
npm run lint:fix

# Lint a single module, fixing errors
cd packages/opentelemetry-module-name
npm lint:fix
npm run lint:fix
```

### Adding a package
Expand Down Expand Up @@ -202,6 +202,7 @@ If all of the above requirements are met and there are no unresolved discussions

### Generating CHANGELOG documentation

- Generate and export your [Github access token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token): `export GITHUB_AUTH=<your_token>`
- `npm run changelog` to generate CHANGELOG documentation in your terminal (see [RELEASING.md](RELEASING.md) for more details).

### Benchmarks
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
"test:browser": "lerna run test:browser",
"test:backcompat": "lerna run test:backcompat",
"bootstrap": "lerna bootstrap",
"changelog": "lerna-changelog",
"codecov": "lerna run codecov",
"codecov:browser": "lerna run codecov:browser",
"predocs-test": "npm run docs",
Expand Down

0 comments on commit a78bb80

Please sign in to comment.