Skip to content

Commit fbc7aa2

Browse files
authored
Update CONTRIBUTING.md (#303)
1 parent af81a52 commit fbc7aa2

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,25 @@ Please make sure to run the tests (`npm test`) before you commit your changes.
3232
3333
## Help needed
3434
35-
Please checkout the [the open issues][issues]
35+
Please checkout the [the open issues][issues]. Issues labelled [**Help
36+
Wanted**][help-wanted] and [**Good First Issue**][good-first-issue] are
37+
especially good to help with.
3638
3739
Also, please watch the repo and respond to questions/bug reports/feature
3840
requests! Thanks!
3941
42+
## Deploying (access only)
43+
44+
If you have access to the npm project, run the following:
45+
46+
```bash
47+
npm run deploy
48+
```
49+
50+
Follow the prompts to release.
51+
4052
[all-contributors]: https://github.com/all-contributors/all-contributors
4153
[egghead]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
54+
[good-first-issue]: https://github.com/manifoldco/swagger-to-ts/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
55+
[help-wanted]: https://github.com/manifoldco/swagger-to-ts/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22
4256
[issues]: https://github.com/manifoldco/swagger-to-ts/issues

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,14 @@
4747
"prettier": {},
4848
"scripts": {
4949
"build": "pika build",
50+
"deploy": "npm run build && pika publish",
5051
"lint": "eslint --ignore-path .gitignore --ext .js,.ts src",
5152
"pregenerate": "npm run build",
5253
"generate": "npm run generate:basic && npm run generate:notypes && npm run generate:nowrapper && npm run generate:nowarning",
5354
"generate:basic": "node pkg/bin/cli example/basic.yaml -o example/basic.ts",
5455
"generate:notypes": "node pkg/bin/cli example/no-types.yaml -o example/no-types.ts",
5556
"generate:nowarning": "node pkg/bin/cli example/basic.yaml -o example/no-warning.ts --no-warning",
5657
"generate:nowrapper": "node pkg/bin/cli example/basic.yaml -o example/no-wrapper.ts --nowrapper",
57-
"publish": "npm run build && pika publish",
5858
"test": "npm run build && jest",
5959
"test:coverage": "npm run build && jest --coverage",
6060
"typecheck": "tsc --noEmit",

0 commit comments

Comments
 (0)