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

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

Abierto
#923 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
25/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
markdown

Línea de trabajo

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.

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

Descripción

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.

Lenguaje dominante
Python
Estrellas
9
Forks
1
Merge medio
8 h 10 min
PR fusionados (30 d)
5

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.