Skip to content
Benedikt Groß edited this page Feb 7, 2016 · 13 revisions

##Getting started

Interested in contributing? Mega!

First, write to benedikt.gross@generative-gestaltung.de to let us know you're interested! If it's not on the issues list, add it. If it's already on this issues list, assign it to yourself or comment on the issue indicating you're working on it. Go ahead and implement it. Submit afterwards a pull request against the master branch (see below for instructions).

Conventions

  • Try to stick as close as possible to the original code.
  • Simply translate the code examples to javascript.
  • Follow the way the code is written by checking already ported examples and get inspired by idiomatic.js
  • Sketches in 01_P are written in Global Mode
  • Sketches in 02_M are written in Instance Mode
  • Every sketch has to have a preview png image e.g. P_1_1_2_01.png
  • Remove the PDF export features, p5.js currently doesn't support this
  • p5 functions aren't defined outside of setup and draw. It's best to declare variables outside setup, and assign them inside setup. Example
  • Favour p5 functions over native javascript ones e.g. int() vs. parseInt()
  • Add 'use strict'; to the beginning of every .js file

Setup

  1. Fork and clone this repository.

    git clone git@github/YOUR_USERNAME/Code-Package-p5.js.git
    
  2. Submit a pull request.

Master branch development

  1. Fork Code-Package-p5.js.git
  2. Make local changes
  3. Commit and push changes
    • Preferable a PR per sketch
    • Mark significant structural changes, if any. (comment the lines via the Github comment feature, example)
  4. Submit a PR against the Code-Package-p5.js/master branch
Clone this wiki locally