Public Lab Wiki documentation



Contributing to Public Lab Software

This is a revision from December 19, 2014 23:26. View all revisions
2 | 30 | | #11487

« Back to Developers

Public Lab welcomes and encourages community contributions to our open source software. This page is intended to

  1. List software projects that Public Lab has incubated and provide links to source code.
  2. Collect software development guidelines and best practices for Public Lab projects.
  3. Help newcomers figure out how and where to start contributing!

Getting started

Quick tips for getting involved with the Public Lab codebases:

  1. Set up a GitHub account and install git. At the moment, the source code for Public Lab's free software is hosted on GitHub, a website which hosts repositories maintained using the git version control software. If you're new to GitHub, you can read more about it at readwrite and get started with git and GitHub yourself here on GitHub.

  2. Join the Public Lab developers mailing list

Contribution Guidelines

Public Lab software is written in many languages, and each project may have its own guidelines for contributors. These broad guidelines should serve as general principles to guide your approach to a new Public Lab codebase.

Contributing using git

Contributing to Ruby projects

Contributing to JavaScript projects

Public Lab Software

Project Description Source Code
MapKnitter Assemble aerial images into maps. github:publiclab/mapknitter
Spectral Workbench Material analysis using DIY spectrometry. github:spectral-workbench
Leaflet.Illustrate Leaflet plugin built for MapKnitter. Enables text annotations on Leaflet maps. github:manleyjster/Leaflet.Illustrate
Leaflet.DistortableImage Leaflet plugin built for MapKnitter. Enables images to be distorted. github:publiclab/Leaflet.DistortableImage
publiclab.org This very website! github:jywarren/plots2
Infragram Analyze plant health with infrared imagery. github:p-v-o-s/infragram-js