From d6e8bea8979497e46d624ba6e4eb722c7965d9d5 Mon Sep 17 00:00:00 2001 From: Jeff Cross Date: Fri, 15 Jan 2016 14:07:43 -0800 Subject: [PATCH] docs(developer): add docs for contributors --- DEVELOPER.md | 22 ++++++++++++++++++++++ package.json | 2 +- 2 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 DEVELOPER.md diff --git a/DEVELOPER.md b/DEVELOPER.md new file mode 100644 index 0000000..016a7f7 --- /dev/null +++ b/DEVELOPER.md @@ -0,0 +1,22 @@ +## Unit Tests + +### Write Unit Tests + +Write tests alongside components and services, as `.spec.ts`: +``` +components/ + - About.ts + - About.spec.ts +``` + +### Run Tests with Karma +``` +$ npm test +``` + +Or + +``` +$ npm install -g karma +$ karma start +``` \ No newline at end of file diff --git a/package.json b/package.json index fc1b722..94c635e 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,7 @@ "description": "", "main": "index.js", "scripts": { - "test": "echo \"Error: no test specified\" && exit 1" + "test": "karma start" }, "author": "", "license": "MIT",