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

Reconcile `code-review.md`'s finding-ID convention with the ID schemes in use (CR-/DOC-/TECH-, F-P4-OPUS, F-P8-C)

Open
#923 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
25/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
markdown
Domain
documentation

Research direction

Start with docs/standards/code-review.md, which defines the two canonical finding-ID forms, then compare it with the CR-/DOC-/TECH- IDs cited in CONTRIBUTING.md and the pull-request template, and the F-P4-OPUS-NN/F-P8-C-NN schemes in the tree. The row itself is at docs/roadmap/risks-and-decisions.md line 93. Done means the convention covers or scopes every ID form, a maintainer has decided on enforcement, the row is removed from the deferral table, and the CHANGELOG names F-PR29-A8-16. Check #712 first to avoid overlap.

Written by the indexing model from the issue text.

Description

documentation severity: low source: roadmap wave: 4

Deferred work · F-PR29-A8-16 · severity Low · cost ~1-2 h · recorded in docs/roadmap/risks-and-decisions.md:93

Summary

docs/standards/code-review.md defines exactly two canonical finding-ID forms, but later review cycles introduced F-P4-OPUS-NN and F-P8-C-NN, and CONTRIBUTING.md, the pull-request template and code-review.md itself now tell contributors to quote the backlog's CR- / DOC- / TECH- IDs, which the convention never mentions. The row was recorded as a rolling enforcement target with no guard and no exit criterion.

Condition or budget

None recorded ("rolling").

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

The convention table lists two forms; the newer schemes appear in the tree and in the contributor documents.

Related

#712 (strip IDs from code comments) is related, not the same change.

Acceptance criteria

  • The convention covers every ID form in use (or states each one's scope), decides whether enforcement is wanted, and the row gets an exit criterion or is closed.
  • 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.