Add CONTRIBUTING.md

fboeller · Mar 7, 2021 · 4054484 · 4054484
1 parent 338841e
commit 4054484
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,18 @@
+# Contributing
+
+## Start the example app
+
+- `npm start example-app`
+
+## Checks
+
+- All: `npm run check`
+- Tests: `npm run test`
+- Lint: `npm run lint`
+- Prettier: `npm run prettier-check`
+
+## Publish
+
+- Adjust version in [package.json](./projects/ngx-loadable/package.json)
+- `npm run package`
+- (You need to have npm access to do that): `npm publish ./dist/ngx-loadable/ngx-loadable-x.x.x.tgz`