Particle is an open-source platform. You might find something you'd like changed, a feature you'd like implemented, or a bug you see a fix for. If so, you can create a pull request or an issue on one of our open-source GitHub repos. Here's a quick run-down of some repos you might want to know about, as well as some information on how to contribute.
Go to http://github.com/particle-iot to see all the available repositories. There are quite a few! Here's a guide to the most popular repos.
Before you contribute to the code base, check out the
style-guides repo. This will give you an idea of how we format our code. If you have additional suggestions on good code practices, please make a pull request.
See the local build tools FAQ for steps to build the firmware on your machine.
There are several mobile repos, for both iOS and Android.
Particle maintains several open source libraries to be used with official Particle shields. They include:
InternetButton: the library intended for use with the Internet Button.
RelayShield: the library intended for use with the Photon Relay Shield
PowerShield: the library intended for use with the Photon Power Shield
We share some hardware design files for each of our dev boards. These open source repos are designed mostly to give you a sense of what we are working on, but you are welcome to make contributions here as well if you have interest and expertise.
Current hardware design repos include:
- Official Libraries such as the
If you're new to GitHub expert, go here to get a sense of GitHub flow. We also suggest the GitHub for Desktop application, which has a great built-in tutorial on forking, editing, merging, and creating a pull request.
If you have your own favorite tutorials on how to
git, make a pull request on this documentation to add them!
Also, check out and join our community forums for advanced help, tutorials, and troubleshooting.