RIOT is an open-source operating system for IoT devices, with contribution guidelines covering code, documentation, and bug reporting.
Field note
This page provides contribution guidelines for RIOT, an open-source IoT operating system. It covers getting started, bug reports, feature requests, coding conventions, commit conventions, pull requests, documentation, and Git workflows.
Capabilities
Tags
Ways to use it
Not filed / Not filed
Product features
Comprehensive API documentation for all modules and functions.
Supports multiple boards like samr21-xpro.
RIOT has extensive coding conventions with static test tools.
Commit messages follow a pattern and are checked for keywords.
Guidelines for behavior in all RIOT community spaces, promoting a welcoming and respectful environment.
Guidelines for contributing code, documentation, and bug reports to RIOT.
Use BUILD_IN_DOCKER=1 to build and flash using the riot/riotbuild Docker image.
Guidance for writing documentation.
Provides examples in examples/ directory.
Examples and tests for modules and packages.
Support for external packages with patching by build system.
Flash RIOT applications to supported boards using make commands, with optional Docker support.
Instructions for working with Git, including branching and rebasing.
Provides messaging and synchronization between threads.
RIOT aims for a very low memory footprint.
Uses make to build applications with BOARD macro.
Use USEMODULE and USEPKG in Makefile to include modules and packages.
PORT macro for native uses TAP interface.
Allows specifying serial interface with PORT.
GitHub pull requests are the primary contribution mechanism.
Uses pyterm as default terminal application.
Interact with the RIOT shell running on the board after flashing.
The kernel includes a scheduler for task management.