From b04a8d8c77a17365667502edfb8cb6d7a4c3792d Mon Sep 17 00:00:00 2001 From: martinRenou Date: Wed, 1 Feb 2023 10:45:36 +0100 Subject: [PATCH] Add contributing section to docs --- docs/contributing.md | 6 ++---- mkdocs.yml | 1 + 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index 39349e7e8..50b481b76 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -9,7 +9,7 @@ Currently there has been an active effort on making the project comply to all es Prettier rules are enforced though and you can run them in the `js` folder with: ```bash - yarn prettier --write . + yarn prettier --write . ``` 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). @@ -24,6 +24,4 @@ Should you have any question, please do not hesitate to reach out to us on the [ ## Help/Documentation -- API reference documentation: [![Read the documentation of the stable version](https://readthedocs.org/projects/pip/badge/?version=stable)](http://bqplot.readthedocs.org/en/stable/) [![Read the documentation of the development version](https://readthedocs.org/projects/pip/badge/?version=latest)](http://bqplot.readthedocs.org/en/latest/) - -- Talk to us on the `ipywidgets` Gitter chat: [![Join the chat at https://gitter.im/ipython/ipywidgets](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ipython/ipywidgets?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) \ No newline at end of file +- Talk to us on the `ipywidgets` Gitter chat: [![Join the chat at https://gitter.im/ipython/ipywidgets](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ipython/ipywidgets?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) diff --git a/mkdocs.yml b/mkdocs.yml index 4c107fd05..611d60ca4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -86,3 +86,4 @@ nav: - Axes: api/axes.md - Interactions: api/interactions.md - Pyplot: api/pyplot.md + - Contributing: contributing.md