Skip to content

Latest commit

 

History

History
27 lines (20 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

27 lines (20 loc) · 1.5 KB
Raw

How can I help?

  1. Be a user, create your own connected devices.
  2. Open an issue if you find any bugs
  3. Join our forum (soon)
  4. Make a Pull Request with your own code
  5. Start or fork this repo ❤️

Remember that

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.
  2. Non-master branches ought to be used for ongoing work.
  3. External API changes and significant modifications ought to be subject to an internal pull-request to solicit feedback from other contributors.
  4. Internal pull-requests to solicit feedback are encouraged for any other non-trivial contribution but left to the discretion of the contributor.
  5. Contributors should attempt to adhere to the prevailing code-style.

Releases

There is yet no plan for this repo to be published as-is. Instead it intends to be a collection of samples, documentation and scripts to help users build connected devices. In the future, other repos may wrap those scripts into a single library for ease of use, in different programming languages.

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.