search

tbs-fpv / tbs-crsf-spec

Team Blacksheep CRSF protocol specification
Other
16 stars 8 forks source link

CI: Add pre commit checks #11

Closed Dazza0 closed 1 day ago

Dazza0 commented 1 day ago

This PR add some basic pre-commit hooks so that basic formatting/typos can be caught locally before committing.

Pre-commit hooks won't take any affect locally until they are installed (see pre-commit docs for more details), thus won't affect anyone who prefers not to use them.

Ilidur commented 1 day ago

Can you please also write some instructions in the readme on how to install the pre-commit hooks?

Dazza0 commented 1 day ago

Can you please also write some instructions in the readme on how to install the pre-commit hooks?

@Ilidur Added CONTRIBUTING.md to describe pre-commit install/usage and any other contributing related details. PTAL again