Linters and formatters for ensuring WPILib's source code conforms to its style guide


Keywords
python, styleguide
License
BSD-3-Clause
Install
pip install wpiformat==2024.34

Documentation

WPILib Style Guide

This repository contains our style guides for C++ and Java code, various IDE support files, and formatting scripts.

Description

Anything submitted to a wpilibsuite project needs to follow the code style guides outlined here. For details about the style, please see the contributors document here.

Style configuration files for IDEs are in the ide folder. The style guides for C++ and Java are named cppguide and javaguide respectively.

Setup

See the wpiformat Python package README.

Contributing to Style Guide

See CONTRIBUTING.md.