From f6c9c85dcb559d2ec889befe8e0d82370b12333a Mon Sep 17 00:00:00 2001 From: Alessandro Gatti Date: Sat, 13 Jun 2026 05:52:53 +0200 Subject: [PATCH] CONTRIBUTING: Remove references to `black`. This commit updates the contribution guidelines, removing references to the `black` formatting tool since `ruff` is used to do both linting and formatting these days. Signed-off-by: Alessandro Gatti --- CONTRIBUTING.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 815d7373c..66aef7ff2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,15 +27,14 @@ or packages from micropython-lib, please post at the The same rules for commit messages, signing-off commits, and commit structure apply [as for the main MicroPython repository](https://github.com/micropython/micropython/blob/master/CODECONVENTIONS.md). -All Python code is formatted using the [black](https://github.com/psf/black) +All Python code is formatted using the [ruff](https://github.com/astral-sh/ruff) tool. You can run [`tools/codeformat.py`](tools/codeformat.py) to apply -`black` automatically before submitting a PR. The GitHub CI will also run the -[ruff](https://github.com/astral-sh/ruff) tool to apply further "linting" -checks. +`ruff` automatically before submitting a PR. The GitHub CI will also use `ruff` +to apply further "linting" checks. Similar to the main repository, a configuration is provided for the -[pre-commit](https://pre-commit.com/) tool to apply `black` code formatting -rules and run `ruff` automatically. See the documentation for using pre-commit +[pre-commit](https://pre-commit.com/) tool to apply `ruff` code formatting +rules and apply linting checks. See the documentation for using pre-commit in [the code conventions document](https://github.com/micropython/micropython/blob/master/CODECONVENTIONS.md#automatic-pre-commit-hooks) In addition to the conventions from the main repository, there are some