Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Request: documents should link what they document

Aperta
#784 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
48/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
html
Ambito
documentation

Direzione di ricerca

Iniziare con il riferimento al metamodello dei documenti collegato nell’issue e confrontarlo con l’esempio di report di verifica del modulo. Determinare come debba essere rappresentata una relazione esplicita tra documento e modulo, incluso il nome del collegamento proposto e il comportamento del backlink. Il lavoro è completato quando il metamodello supporta la relazione e il report può utilizzarla per la tracciabilità.

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

Descrizione

My concrete example is the module verification report

Currently the analyzed module can be determined from the id only, or from being in the same repository. While that is theoretically enough for traceability, a more explicit link would help traceability tooling.

Proposal: extend document with a documents or affects or belongs_to links or similar, which would link to the mod in question.

This will also establish a backlink from modules to module verification reports.


Todays workaround is a custom type which has such a link. This allows automated generation of such reports.

Image
Lingua principale
HTML
Stelle
5
Fork
22
Merge medio
6h 26m
PR unite (30g)
7

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

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 eclipse-score/process_description

Tutte le issue di eclipse-score/process_description

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.