Skip to content

Latest commit

 

History

History
27 lines (19 loc) · 832 Bytes

CONTRIBUTING.md

File metadata and controls

27 lines (19 loc) · 832 Bytes
Raw

Contribution Guidelines

Pull requests are welcome. We don't have a specific template for PRs. Please follow style guides for Python and C++.

Python

For Python style, we follow PEP 8 and PEP 257.

C++/Arduino

For C++ we follow the Google style guide. We encourage you to run your code against clang-tidy and clang-format. Once clang-tidy and clang-format are installed, you can do so as follows.

cd src/tinyml_deployment
get_idf
idf.py build
chmod +x clean_compile_commands.sh
./clean_compile_commands.sh
clang-tidy main/src/*.cpp -p build/
clang-format main/src/*.cpp -i

Architecture

Please follow the structure laid out in ARCHITECTURE.md.