| 1 |
# Contributing to bqplot |
| 2 |
|
| 3 |
## Conforming with linters |
| 4 |
|
| 5 |
This projects uses both [eslint](https://eslint.org/) and [prettier](https://github.com/prettier/prettier) and the plugin that creates the integration between both, [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier) to lint its code. |
| 6 |
|
| 7 |
Currently there has been an active effort on making the project comply to all eslint rules so the eslint rules are currently not enforced. |
| 8 |
|
| 9 |
Prettier rules are enforced though and you can run them in the `js` folder with: |
| 10 |
|
| 11 |
```bash |
| 12 |
yarn prettier --write . |
| 13 |
``` |
| 14 |
|
| 15 |
The configuration of this project linters were based in the [widgets-cookiecutter](https://github.com/jupyter-widgets/widget-ts-cookiecutter/tree/master/%7B%7Bcookiecutter.github_project_name%7D%7D). |
| 16 |
|
| 17 |
## Governance and code of conduct |
| 18 |
|
| 19 |
Bqplot is subject to the [bqplot governance](https://github.com/bqplot/governance/blob/master/governance.md) and the [bqplot code of conduct](https://github.com/bqplot/governance/blob/master/code_of_conduct.md). |
| 20 |
|
| 21 |
## Questions |
| 22 |
|
| 23 |
Should you have any question, please do not hesitate to reach out to us on the [ipywidgets gitter chat](https://gitter.im/jupyter-widgets/Lobby). |
| 24 |
|
| 25 |
## Help / Documentation |
| 26 |
|
| 27 |
- API reference documentation: [](http://bqplot.readthedocs.org/en/stable/) [](http://bqplot.readthedocs.org/en/latest/) |
| 28 |
|
| 29 |
- Talk to us on the `ipywidgets` Gitter chat: [](https://gitter.im/ipython/ipywidgets?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |