voila-dashboards / voici

Voici turns any Jupyter Notebook into a static web application
https://voici.readthedocs.io/
Other
145 stars 8 forks source link

Add `CONTRIBUTING.md` #48

Closed jtpio closed 1 year ago

jtpio commented 1 year ago

Problem

Currently there is no CONTRIBUTING.md file to list the steps for contributing to the project.

Although one can infer the steps from experience with similar projects:

python -m pip install -e .
yarn
yarn run build
voici build

Suggested Improvement

Let's create CONTRIBUTING.md to make it easier for other contributors to get into the project.