Skip to content
This repository has been archived by the owner on Feb 26, 2024. It is now read-only.

Commit

Permalink
docs(developer): add developer notes and fix karma local run
Browse files Browse the repository at this point in the history
Add very basic developer notes on how to test and submit changes.

Fix the license info at the end of README.md.

Fix the local karma config so it actually runs firefox.

Closes #285
  • Loading branch information
juliemr authored and mhevery committed Mar 21, 2016
1 parent 5e72c01 commit 4d108ce
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 1 deletion.
21 changes: 21 additions & 0 deletions DEVELOPER.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Submitting Changes
------------------

Do NOT submit changes to the built files in the `dist` folder. These are generated before
releases.


To run tests
------------

Make sure your environment is set up with:

`npm install`

In a separate process, run the WebSockets server:

`node ./test/ws-server.ts`

Run the tests using Karma:

`npm test`
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -308,4 +308,4 @@ zone.run(function() {


## License
Apache 2.0
MIT
1 change: 1 addition & 0 deletions karma.conf.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ module.exports = function (config) {

plugins: [
require('karma-chrome-launcher'),
require('karma-firefox-launcher'),
require('karma-jasmine'),
require('karma-sourcemap-loader'),
require('karma-webpack')
Expand Down

0 comments on commit 4d108ce

Please sign in to comment.