Skip to content

Commit

Permalink
chore(build): improve developer workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
ccrowhurstram committed Oct 24, 2016
1 parent 064629d commit 50993af
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
15 changes: 11 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,26 @@ CONTRIBUTING
2. In locally cloned repo: `npm install && npm run setup`
3. Prove existing code:
* Run the unit tests: `npm test`
* Run the end-to-end tests:
* In one terminal window: `npm run e2e-server`
* In another terminal window: `npm run e2e`
* Run the end-to-end tests (see section below)
4. Make changes in `src` folder
* **Tip**: use `npm run test:w` to verify your changes on save
5. Add additional unit tests in `test` folder. These should cover your changes
6. *Optionally* add end-to-end tests in `e2e` folder
7. Prove changes (run step 3 above)
7. Prove changes:
* Run the unit tests: `npm test`
* Run the end-to-end tests (see section below)
8. Commit changes: `npm run cm`
- why use **npm** and not **git** to commit? See "Conventional commit message" section below
9. Push your changes to your fork and submit a pull request


## Running end-to-end tests

* In one terminal window: `npm run e2e-server`
* In another terminal window: `npm run e2e`
* **Tip**: use `npm run e2e-only` if you already have built source code (ie you've `npm run setup` or `npm run build:all`)


## Conventional commit message

This project uses the structure of the commit message to:
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -102,14 +102,14 @@
"doc": "typedoc --options typedoc.json index.ts",
"e2e-server": "http-server demo-apps -c-1",
"e2e-server:ci": "http-server demo-apps -s -c-1 &",
"e2e": "protractor e2e/protractor.config.js",
"e2e": "npm run build:all && npm run e2e-only",
"e2e:ci": "protractor e2e/protractor-travis.config",
"poste2e": "node ./scripts/open-e2e-report",
"e2e-only": "protractor e2e/protractor.config.js",
"poste2e-only": "node ./scripts/open-e2e-report",
"install:demo-apps": "shx ls -d demo-apps/*/ | bulk -c \"npm install\"",
"link:demo-apps": "shx ls -d demo-apps/*/ | bulk -c \"npm run linklocal\"",
"precommit": "npm run tsc",
"semantic-release": "semantic-release pre && npm publish && semantic-release post",
"serve:api-docs": "http-server demo-site/api-docs -o -c-1",
"serve:demo": "cd demo-apps/es5 && npm start",
"serve:docs-site": "http-server demo-site -o -c-1",
"_setup:common": "npm-run-all --parallel build:full tsc --serial install:demo-apps link:demo-apps",
Expand Down

0 comments on commit 50993af

Please sign in to comment.