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

Aperta
  • Qualcosa non va?
#453 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
markdown, rust, yaml
Ambito
tooling

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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).

Lingua principale
Rust
Stelle
8
Fork
1
Merge medio
3h 26m
PR unite (30g)
66

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di sjames/syscribe

Tutte le issue di sjames/syscribe

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.