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

Document the public API of @usine/engine in TSDoc

Chiusa
  • Qualcosa non va?
#301 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à
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
55/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
typescript
Ambito
documentation

Direzione di ricerca

Read AGENTS.md and CONTEXT.md, then inspect the public exports and subpaths in packages/engine and the generated API reference at apps/docs/src/content/docs/reference/api/engine/. Document exports first, then members and service operations using domain vocabulary; consult linked ADRs where they explain a rule. Run pnpm build and pnpm turbo run build --filter=@usine/docs; done means both builds pass and the regenerated reference has zero undocumented items from the stated counts.

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

Descrizione

Part of #294. In packages/engine, 13 of 70 top-level exports and 103 of 151 own fields, methods and service operations of the public subpaths have no TSDoc (counted from the generated API reference at https://docs.usine.dev/reference/api/engine/ on 2026-10-17).

Document each exported element in domain terms, as AGENTS.md asks: what it represents, what its arguments mean, and what callers can expect beyond the TypeScript signature. Use the vocabulary of CONTEXT.md. Link an ADR when it explains a rule. Plain sentences, no literary verbs for objects, no em dashes.

Scope: TSDoc only. No behaviour change, no renames. Do the exports first, then members and service operations. If an export turns out to be an implementation detail that should not be public, say so in the PR instead of documenting it.

Done when pnpm build passes and the counts above are zero in the regenerated reference (pnpm turbo run build --filter=@usine/docs, then open apps/docs/src/content/docs/reference/api/engine/).

Decisions (2026-10-28)

  • Recount the gaps from a fresh pnpm turbo run build --filter=@usine/docs; the counts in #294 are from 2026-10-17 and stale.
  • Follow the merged siblings #320 (expression), #321 (durable), and #323 (executor): Google API-reference comments (AGENTS.md), ADRs cited as plain "(ADR NNNN)" text rather than relative links, and one changeset for the package.
  • Comments only; no behavior change.
Lingua principale
TypeScript
Stelle
1
Fork
0
Merge medio
4h 26m
PR unite (30g)
280

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 basaltbytes/usine

Tutte le issue di basaltbytes/usine

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.