2017-03-20 09:02:25 +00:00
|
|
|
## Contributing
|
|
|
|
|
|
|
|
Due to the precarious nature of the Open Specifications Promise, it is very
|
|
|
|
important to ensure code is cleanroom. Consult CONTRIBUTING.md
|
|
|
|
|
2017-04-09 07:11:08 +00:00
|
|
|
### OSX/Linux
|
|
|
|
|
2017-03-20 09:02:25 +00:00
|
|
|
The xlsx.js file is constructed from the files in the `bits` subdirectory. The
|
|
|
|
build script (run `make`) will concatenate the individual bits to produce the
|
|
|
|
script. Before submitting a contribution, ensure that running make will produce
|
|
|
|
the xlsx.js file exactly. The simplest way to test is to add the script:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
$ git add xlsx.js
|
|
|
|
$ make clean
|
|
|
|
$ make
|
|
|
|
$ git diff xlsx.js
|
|
|
|
```
|
|
|
|
|
|
|
|
To produce the dist files, run `make dist`. The dist files are updated in each
|
|
|
|
version release and *should not be committed between versions*.
|
|
|
|
|
2017-04-09 07:11:08 +00:00
|
|
|
### Windows
|
|
|
|
|
|
|
|
The included `make.cmd` script will build `xlsx.js` from the `bits` directory.
|
|
|
|
Building is as simple as:
|
|
|
|
|
|
|
|
```cmd
|
2017-04-24 10:39:00 +00:00
|
|
|
> make
|
2017-04-09 07:11:08 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
To prepare dev environment:
|
|
|
|
|
|
|
|
```cmd
|
2017-04-24 10:39:00 +00:00
|
|
|
> make init
|
|
|
|
```
|
|
|
|
|
|
|
|
The full list of commands available in Windows are displayed in `make help`:
|
|
|
|
|
|
|
|
```
|
|
|
|
make init -- install deps and global modules
|
|
|
|
make lint -- run eslint linter
|
|
|
|
make test -- run mocha test suite
|
|
|
|
make misc -- run smaller test suite
|
|
|
|
make book -- rebuild README and summary
|
|
|
|
make help -- display this message
|
2017-04-09 07:11:08 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
The normal approach uses a variety of command line tools to grab the test files.
|
|
|
|
For windows users, please download the latest version of the test files snapshot
|
|
|
|
from [github](https://github.com/SheetJS/test_files/releases)
|
|
|
|
|
|
|
|
Latest test files snapshot:
|
|
|
|
<https://github.com/SheetJS/test_files/releases/download/20170409/test_files.zip>
|
2017-03-20 09:02:25 +00:00
|
|
|
|
2017-04-09 07:11:08 +00:00
|
|
|
Download and unzip to the `test_files` subdirectory.
|
2017-04-10 05:10:54 +00:00
|
|
|
|