Skip to content

Commit a78bb80

Browse files
authored
docs: update contribution documentation (#1858)
1 parent b85acf0 commit a78bb80

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -143,22 +143,22 @@ This project uses a combination of `gts` and `eslint`. Just like tests and compi
143143

144144
```sh
145145
# Lint all modules
146-
npm lint
146+
npm run lint
147147

148148
# Lint a single module
149149
cd packages/opentelemetry-module-name
150-
npm lint
150+
npm run lint
151151
```
152152

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

155155
```sh
156156
# Lint all modules, fixing errors
157-
npm lint:fix
157+
npm run lint:fix
158158

159159
# Lint a single module, fixing errors
160160
cd packages/opentelemetry-module-name
161-
npm lint:fix
161+
npm run lint:fix
162162
```
163163

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

203203
### Generating CHANGELOG documentation
204204

205+
- 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>`
205206
- `npm run changelog` to generate CHANGELOG documentation in your terminal (see [RELEASING.md](RELEASING.md) for more details).
206207

207208
### Benchmarks

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
"test:browser": "lerna run test:browser",
1919
"test:backcompat": "lerna run test:backcompat",
2020
"bootstrap": "lerna bootstrap",
21+
"changelog": "lerna-changelog",
2122
"codecov": "lerna run codecov",
2223
"codecov:browser": "lerna run codecov:browser",
2324
"predocs-test": "npm run docs",

0 commit comments

Comments
 (0)