Test that SPEC 3.6 lists every confirmable action

Aperta Adatta ai principianti
#143 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
78/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
typescript
Ambito
testing

Direzione di ricerca

Leggi apps/api/src/modules/confirmations/domain/confirmation-token.ts per vedere il catalogo CONFIRMABLE_ACTIONS ed esamina la sezione 3.6 di docs/SPEC.md. Individua le convenzioni esistenti per i test unitari e aggiungi un test che verifichi che ogni azione del catalogo sia menzionata lì. Il lavoro è completato quando il test passa ora e fallisce se viene aggiunta un'azione fittizia non documentata.

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

Descrizione

documentation good first issue priority:P3 track:control-plane

CONFIRMABLE_ACTIONS in apps/api/src/modules/confirmations/domain/confirmation-token.ts is the closed catalog of destructive actions that need a confirmation.

Task

Add a unit test that reads docs/SPEC.md and fails when an action of the catalog is not mentioned in section 3.6, so the documentation cannot fall behind the code.

Acceptance

The test passes today and fails if you add a fake action to the catalog without documenting it.

Lingua principale
TypeScript
Stelle
2
Fork
1
Merge medio
7h 17m
PR unite (30g)
197

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 shipkeepdev/shipkeep

Tutte le issue di shipkeepdev/shipkeep

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.