Skip to content

Commit f091250

Browse files
committed
Add CONTRIBUTING.md with setup instructions
1 parent f084acf commit f091250

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

CONTRIBUTING.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Contributing
2+
3+
## Setup
4+
5+
Install Global Depenedencies if needed:
6+
```
7+
npm install -g typings gulp
8+
```
9+
10+
Clone the repository:
11+
```
12+
git clone https://github.com/Microsoft/PowerBI-JavaScript.git powerbi-client
13+
```
14+
15+
Install Dependencies:
16+
```
17+
npm install
18+
typings install
19+
```
20+
21+
Build:
22+
```
23+
gulp build
24+
```
25+
Or if using VScode: `Ctrl + Shift + B`
26+
27+
Test
28+
```
29+
// PhantomJS
30+
gulp test
31+
// Chrome (Singel Run: true)
32+
gulp test --debug
33+
// Chrome (Single Run: false)
34+
gulp test --debug --watch
35+
```
36+
37+
The build and tests use webpack to compile all the source modules into one bundled module that can execute in the browser.
38+
39+
## Known Problems:
40+
Currently the biggest problem is that `.d.ts` file is not automatically generated.
41+
The typescript compiler can output declaration files for each typescript file but does not yet have the capability to output a single declaratione file from multiple modules.
42+
43+
See: https://github.com/Microsoft/TypeScript/issues/4433
44+
45+
The current process is to run tsc with declarations then manually concatenate each file and remove the irrelavant import and export statements.
46+
If this becomes to much of a problem we could move all the source to a single file.
47+
48+

0 commit comments

Comments
 (0)