Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto
  • ¿Algo no está bien?
#921 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
42/100
Tipo de issue
Refactorización
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
python
Área
developer-experience

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Python
Estrellas
9
Forks
1
Merge medio
11 h 6 min
PR fusionados (30 d)
29

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de HodeTech/ForgeLM

Todos los issues de HodeTech/ForgeLM

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.