From e14c0310ad1a6c7a5da971ba6b6b0fcb927aa6d5 Mon Sep 17 00:00:00 2001 From: olgagaga Date: Fri, 15 May 2026 17:20:15 -0400 Subject: [PATCH] docs(contributing): warn that `ruff format` predates the codebase The Development Setup block instructs new contributors to run `ruff format nanobot/`, but the tree predates the formatter and many lines exceed the configured 100-char limit (E501 is ignored). Running the command as documented produces an ~80-file unrelated diff that buries real changes. Document this and recommend formatting only the files actually touched. --- CONTRIBUTING.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index de3b3676f..861d6fb8a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -103,8 +103,11 @@ pytest # Lint code ruff check nanobot/ -# Format code -ruff format nanobot/ +# Format code — optional. The existing tree predates `ruff format`, +# so running it across `nanobot/` produces a large unrelated diff +# (E501 is ignored, so many existing lines exceed the 100-char setting). +# Format only files you've actually touched, not the whole package. +ruff format ``` ## Contribution License