From 685a23e4637f717f2910df66a034e79ec515ee03 Mon Sep 17 00:00:00 2001 From: Julian Oes Date: Thu, 11 Sep 2025 21:53:16 +1200 Subject: [PATCH] README: document ruff checks --- .github/workflows/main.yml | 2 +- README.md | 9 +++++++++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 72d14b04..d81a1f1e 100644 --- a/.github/workflows/main.yml +++ b/.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 diff --git a/README.md b/README.md index 46e5c452..c37798ac 100644 --- a/README.md +++ b/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