Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

41 lines (26 loc) · 1.82 KB

Contributing to ml5.js Examples

This project is still a work in progress, but we encourage everyone to join, propose ideas and help in the development!

Structure and Syntax

We are trying to keep things as simple as possible. ml5.js aims to make machine learning approachable for a broad audience of artists, creative coders, and students. The library provides access to machine learning algorithms and models in the browser and we try to keeps things simple for everyone.

Each example in this repository is self-contained. Meaning that it can be used with out external dependencies or files. Just the folder where the example live is necessary.

The folders are structure based on examples built with other JavaScript frameworks/libraries. This means we aim to have the following structure:

javascript/
p5/
three/
rita/
pixi/
etc..

Please refer to #1 (thanks @dariusk), to see why we settle for this.

Getting Started

Since all the example are self contained, if you want to contribute by fixing bugs, adding documentation or adding new examples, just start by cloning or downloading this repository:

git clone https://github.com/ml5js/ml5-examples.git
cd ml5-examples

Make some changes, fix bugs and submit a new pull request!

We encourage everyone to contribute to this project. If you have never contributed to open source before this might be a good place to start! Just open a new issue!

Additional Resources