diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9e155a6be6..e39e605558 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 @@ -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=` - `npm run changelog` to generate CHANGELOG documentation in your terminal (see [RELEASING.md](RELEASING.md) for more details). ### Benchmarks diff --git a/package.json b/package.json index 0b72aa1a28..11dc2385ad 100644 --- a/package.json +++ b/package.json @@ -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",