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

Commit 4d108ce

Browse files
juliemrmhevery
authored andcommitted
docs(developer): add developer notes and fix karma local run
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
1 parent 5e72c01 commit 4d108ce

File tree

3 files changed

+23
-1
lines changed

3 files changed

+23
-1
lines changed

Diff for: DEVELOPER.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Submitting Changes
2+
------------------
3+
4+
Do NOT submit changes to the built files in the `dist` folder. These are generated before
5+
releases.
6+
7+
8+
To run tests
9+
------------
10+
11+
Make sure your environment is set up with:
12+
13+
`npm install`
14+
15+
In a separate process, run the WebSockets server:
16+
17+
`node ./test/ws-server.ts`
18+
19+
Run the tests using Karma:
20+
21+
`npm test`

Diff for: README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -308,4 +308,4 @@ zone.run(function() {
308308

309309

310310
## License
311-
Apache 2.0
311+
MIT

Diff for: karma.conf.js

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ module.exports = function (config) {
1515

1616
plugins: [
1717
require('karma-chrome-launcher'),
18+
require('karma-firefox-launcher'),
1819
require('karma-jasmine'),
1920
require('karma-sourcemap-loader'),
2021
require('karma-webpack')

0 commit comments

Comments
 (0)