Add information on documenting directives
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 142
- Fork
- 230
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
We don't currently have any guidelines around documenting elements or directives. Might be something like this:
## Documenting directives
To add API documentation to directives, we recommend adding a doc comment on the directive function:
```ts
/**
* Renders a placeholder message until `promise` resolves, then renders the
* value of the fulfilled promise.
* @param promise A promise that yields a value to render
*/
export const resolvePromise = directive(ResolvePromise);
```
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Individua la sezione appropriata della documentazione nel repository lit.dev per le indicazioni sulla directive API. Usa come punto di partenza il contenuto e l’esempio proposti “Documenting directives”; il lavoro sarà completato quando la documentazione pubblicata spiegherà i commenti di documentazione e la documentazione dei parametri per le directives.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 48/100