Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
dwblair committed Sep 24, 2016
1 parent e56e9f8 commit da15db0
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Contributing to the Riffle project

Any modifications or extensions to the circuit board designs, or new code, is very much welcomed!

* Replicating the Riffle setup and documenting your use of it on [publiclab.org](https://publiclab.org) with the tag "[riffle](https://publiclab.org/tag/riffle)." If you record your experiences elsewhere, please contact us and share.
* Expanding our documentation of water monitoring research and projects on [the Public Lab Wiki.](https://publiclab.org/wiki/riffle)
* Improving the documentation on riffle applications on [Public Lab](publiclab.org).
* Adding your comments to [open issues in this repository](/issues).
* Forking this repository and improving the design documentation, assembly instructions, or to add hardware or software for acquiring and interpretting data.

#Contributing to an OPEN Open Source project repository

This is an [OPEN Open Source](http://openopensource.org/) hardware project. Please fork it and work in your own copy, and file pull requests back to the master branch.


## What?

Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.

## Rules

There are a few basic ground-rules for contributors:

1. **No `--force` pushes** or modifying the Git history in any way.
1. **Non-master branches** ought to be used for ongoing work.
1. **significant modifications** ought to be subject to an **internal pull-request** to solicit feedback from other contributors.
1. Internal pull-requests to solicit feedback are *encouraged* for any other non-trivial contribution but left to the discretion of the contributor.
1. Contributors should attempt to adhere to the prevailing style.

## Releases

Stick to semver: Major.Minor.Patch.

## Changes to this arrangement

This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change.

0 comments on commit da15db0

Please sign in to comment.