Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

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

Open
#921 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
42/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Active
Tech stack
python

Research direction

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.

Written by the indexing model from the issue text.

Description

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.

Dominant language
Python
Stars
9
Forks
1
Avg merge
8h 10m
Merged PRs (30d)
5

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from HodeTech/ForgeLM

All issues in HodeTech/ForgeLM

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.