| 1 | # Contributing
|
| 2 |
|
| 3 | ## How to run tests
|
| 4 |
|
| 5 | ```bash
|
| 6 | yarn test
|
| 7 | ```
|
| 8 |
|
| 9 | ## How to generate the documentation
|
| 10 |
|
| 11 | The contents of [API.md](API.md) are generated from comments in the source code.
|
| 12 | To update API.md, run the following command:
|
| 13 |
|
| 14 | ```bash
|
| 15 | yarn docs
|
| 16 | ``` |
| \ | No newline at end of file |