State in the canon that an entity's ID never changes

Aperta Adatta ai principianti
  • Qualcosa non va?
#129 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à
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
72/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
bash
Ambito
documentation

Direzione di ricerca

Inizia da docs/reference/glossary.md, nella sezione sull'unicità degli ID §, e leggi come vi vengono descritti gli ID. Poi verifica che la formulazione corrisponda ai workflow delle skill citati nell'issue ("Rename a Feature" e "Split or merge a Feature"). Aggiungi accanto a quella sezione la regola secondo cui un ID non cambia mai e non viene mai riutilizzato. Esegui quindi bash agentic/scripts/sync-canon-copies.sh all per rigenerare le copie canoniche. È fatto quando la regola compare nel glossario, le copie rigenerate la contengono e il § Check in AGENTS.md passa.

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

Descrizione

type:tech-debt
Description of Technical Debt

Owner decision: an entity's ID (US-, FEAT-, FUNC-, AC:) never changes, not on a rename and not after the entity
is retired, and it is never reused. A rename changes the name only; a split or a merge creates new entities with new
IDs and retires the old one with superseded_by. The agentic layer follows it already: living-doc-update's "Rename a
Feature" changes the name only, and a "Split or merge a Feature" workflow exists. Two tests guard it,
test_entity_ids_never_change and test_retired_id_is_never_reused. docs/reference/glossary.md § ID uniqueness
only implies it ("an ID denotes the same entity everywhere it appears").

Impact of Technical Debt
  • The rule lives only in the skills; an author or a tool reading the canon cannot find it.
  • The canon copies the skills read are generated from the glossary, so the skills state a rule their own canon lacks.
Category

Documentation

Priority

Medium - Should be addressed soon

Proposed Solution

Add the rule beside § ID uniqueness in docs/reference/glossary.md, regenerate the canon copies (bash agentic/scripts/sync-canon-copies.sh all), and run AGENTS.md § Check.

Effort Estimate

2 hours

Dependencies / Related

No response

Additional Context

Measured 2026-11-12 at living-doc 2df73dc. Re-check:

grep -n -i "never changes" docs/reference/glossary.md is empty while this is open.

Lingua principale
Python
Stelle
0
Fork
0
Merge medio
6h 14m
PR unite (30g)
27

Preparare l'ambiente

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 AbsaOSS/living-doc

Tutte le issue di AbsaOSS/living-doc

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.