mirror/nanobot
1
0
Fork 0
mirror of https://github.com/HKUDS/nanobot.git synced 2026-05-19 08:02:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(contributing): warn that ruff format predates the codebase

Browse Source 
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.
This commit is contained in:
olgagaga 2026-05-15 17:20:15 -04:00 committed by Xubin Ren
parent 2e31002e6e
commit e14c0310ad
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTING.md
View File

@ -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 <files-you-changed>
```
## Contribution License