Stable requirement item ids and checked references to items and PlanningItem questions (REQ-X#item, PI-Y#Q31)

Abierto
  • ¿Algo no está bien?
#453 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
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
markdown, rust, yaml
Área
tooling

Línea de trabajo

Start with the structured questions work in related issue #436 and the reference lint work in #74, then trace how validate, lint-docs, and refs resolve element ids. Check how Requirements and PlanningItem questions are represented before choosing between the proposed stable ids and structured items. Done means item and question references resolve, missing or open references produce the specified warnings, and item-level impact identifies only citing elements.

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

Descripción

Problem

Requirements are commonly written as numbered items ("1. … 2. …"), and other elements cite them in prose as REQ-X item 5, and planning-item questions as PI-Y Q31. check-ref and lint-docs resolve element ids, but not the item or question part, so:

  • a reference to an item that does not exist (or moved after an insertion) is not reported;
  • inserting an item renumbers the rest and silently breaks every citation;
  • an element that cites a question that is still open (e.g. "owner to confirm, Q13") is not flagged, so such markers stay after the question is answered.

Proposal

  • Optional stable item ids inside a Requirement body (e.g. 1. {#grant-keys} **Server keys.** …, or a structured items: list), rendered with their number.
  • Reference syntax for items and questions (REQ-X#grant-keys, REQ-X item 5 accepted as a legacy form, PI-Y#Q31), resolved by validate, lint-docs and refs.
  • Warnings: reference to a missing item/question; reference to an open question from an element whose status is above draft; an answered question still cited with "to confirm"-style wording (heuristic, configurable).
  • impact and suspect links at item granularity: changing item 5 marks only elements citing item 5.

Related

#436 (questions are now structured, which makes #Qn resolution possible), #74 (lint-docs references).

Lenguaje dominante
Rust
Estrellas
8
Forks
1
Merge medio
3 h 26 min
PR fusionados (30 d)
66

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

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 sjames/syscribe

Todos los issues de sjames/syscribe

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.