Skip to content

SKILLS.md: document logging/formatting and type-hint conventions - #3264

Merged
doomedraven merged 1 commit into
masterfrom
skills-logging-format
Sep 30, 2026
Merged

doomedraven merged 1 commit into
masterfrom
skills-logging-format

Conversation

@doomedraven

Copy link
Copy Markdown
Collaborator

Adds three conventions to SKILLS.md -> Coding Standards:

  • Logging: pass args lazily (log.x("... %s", v)), never pre-formatted (f-string / % / .format() / +). Already enforced by the ruff G rules in pyproject.toml; documenting the reason (deferred formatting, stable message grouping).
  • Non-logging strings: prefer f-strings.
  • Type hints: project requires Python >= 3.10 -> builtin generics and X | None instead of typing.Dict/List/Optional, with the ruff command to convert touched files.

Docs only. Follow-up to #3263, where these were applied to modules/processing/network.py.

@doomedraven
doomedraven merged commit 3ae0917 into master Sep 30, 2026
7 checks passed
@doomedraven
doomedraven deleted the skills-logging-format branch September 30, 2026 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant