Merge pull request #797 from mavlink/pr-update-readme

README: document ruff checks

Author: julianoes

.github/workflows/main.yml

@@ -21,7 +21,7 @@ jobs:
           tags: true
           fetch-depth: 0
 
-      - name: Install pip
+      - name: Install pip and pipx
         run: sudo apt-get install -y python3-pip pipx
 
       - name: Check style

README.md

@@ -129,6 +129,15 @@ pip3 install -r requirements-docs.txt
 make -C mavsdk html
 ```
 
+### Formatting checks before committing
+
+We use the following checks in [CI](.github/workflows/main.yml):
+
+```
+pipx run ruff format --check --line-length=100 examples
+pipx run ruff check --select=ASYNC,RUF006,E,F --line-length=100 examples
+pipx run codespell .
+```
 
 ### Release steps