Skip to content

Latest commit

 

History

History
16 lines (9 loc) · 1.05 KB

CONTRIBUTING.md

File metadata and controls

16 lines (9 loc) · 1.05 KB

Contributions

All contributors must first sign the Particle Individual Contributor License Agreement (CLA), which is based on the Google CLA, and provides the Particle team a license to re-distribute your contributions.

Whenever possible, please follow these guidelines for contributions:

  • Keep each pull request small and focused on a single feature or bug fix.
  • Familiarize yourself with the code base, and follow the formatting principles adhered to in the surrounding code.
  • Wherever possible, provide unit tests for your contributions.
  • If the changes have an impact application developers, then those changes should be described in the documentation.

Tests and Documentation

Any changes that affect firmware application developers, such as a new class or API, or change in existing behavior should have an accompanying PR to the particle/docs repo describing the changes. This ensures the documentation is kept up to date with changes to the firmware.