Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Pilot ruff's pydocstyle (`D`, Google convention) and pyupgrade (`UP`) rules on `forgelm/`

Aperta
  • Qualcosa non va?
#921 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
42/100
Tipo di issue
Refactoring
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
python
Ambito
developer-experience

Direzione di ricerca

Start with the [tool.ruff.lint] select list in pyproject.toml, which currently has F, E9, W, B and I, and the Google docstring rule in coding.md. Run ruff with the UP and D (convention google) rules against forgelm/ to see the current violations. Done means UP is enabled with its auto-fixes applied or rejected with a reason, D is adopted or rejected with a reason, and the deferral row is removed with its ID named in the CHANGELOG.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

area: dev-tooling severity: low source: roadmap wave: 4

Deferred work · F-PR29-A7-10 · severity Low · cost ~1 day · recorded in docs/roadmap/risks-and-decisions.md:89

Summary

[tool.ruff.lint] selects only F, E9, W, B and I, so nothing enforces the Google-style docstrings coding.md requires. A dry run with ruff 0.15.21 on forgelm/ reports 104 pydocstyle violations under the Google convention (18 auto-fixable) and 1,728 pyupgrade violations (1,578 auto-fixable). The PR #29 review deferred this as a one-day pilot scoped to forgelm/, noting that UP is the smaller win and could land first.

Condition or budget

None recorded (the row still names v0.6.x).

State today (re-checked 2026-10-09)

pyproject.toml still selects ["F", "E9", "W", "B", "I"]; no pydocstyle configuration exists.

Related

#643 asks to add E722 / BLE to the selection — a different rule set.

Acceptance criteria

  • UP is enabled for forgelm/ with its auto-fixes applied, or rejected with a reason.
  • D with convention = "google" is piloted on forgelm/ and either adopted (violations fixed) or rejected with a recorded reason.
  • The row is removed from the deferral table and the CHANGELOG names its ID (the table's removal contract).

Recorded in docs/roadmap/risks-and-decisions.md (read at f94595f) and re-checked against the code on 2026-10-09. The row leaves that table only when the fix is on main, the CHANGELOG names its ID and any promised guard exists.

Lingua principale
Python
Stelle
9
Fork
1
Merge medio
8h 10m
PR unite (30g)
5

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di HodeTech/ForgeLM

Tutte le issue di HodeTech/ForgeLM

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.