Add an index for `docs/specs/`

Aperta Adatta ai principianti
#41 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
83/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
swift
Ambito
documentation

Direzione di ricerca

Leggi i titoli e le righe Status in docs/specs/*, incluso 0002-claude-code-notch-popup/, poi controlla la pulizia degli stati nelle issue #39 e #40. Aggiungi una riga per ogni spec a docs/specs/README.md con il numero, il titolo, lo stato e la funzionalità coperta, e collega l’indice dalla sezione “How the code is laid out” di CONTRIBUTING.md. Verifica che ogni spec compaia una sola volta e che tutti i link funzionino.

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

Descrizione

documentation good first issue

Labels: documentation, good first issue · Difficulty: easy (about 1 hour)

Problem
There are 35 numbered specs. CONTRIBUTING.md tells contributors to "read the matching one before changing a feature", but there is no list that says which spec covers which feature.

Expected outcome
A docs/specs/README.md with one row per spec: number, title, status, and the feature it covers.

Relevant files

  • docs/specs/* (read each title and Status line)
  • CONTRIBUTING.md (link the index from "How the code is laid out")

Acceptance criteria

  • Every spec file appears once, including the directory spec 0002-claude-code-notch-popup/.
  • Statuses match the files. Do the status cleanup in #39 and #40 first, or note the mismatch.
  • CONTRIBUTING.md links to the index.
  • All links resolve.
Lingua principale
Swift
Stelle
1
Fork
1
Merge medio
14m
PR unite (30g)
15

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 thecharydev/catnotch

Tutte le issue di thecharydev/catnotch

Issue simili

Altre issue su Swift

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.