testing-library / testing-library/testing-library-docs
Improve Angular Testing Library API documentation
Nessuno ha ancora preso questa issue.
- Lingua principale
- JavaScript
- Stelle
- 479
- Fork
- 740
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
I am new to Angular Testing and stumbled across some misunderstandings while writing my first tests. I would like to help you improve it, so let's start collecting the issues. 🙂
- The example for the declarations (within RenderOptions) is wrong. It configures the providers. Furthermore there is no descriptions for the providers option. https://testing-library.com/docs/angular-testing-library/api#declarations
- We might also add a note which of the RenderOptions are passed to the Angular TestBed. Or even separate those from the added render properties.
- Explaining that this library still works with the core testing functionality of Angular under the hood will also help to implement non-standard situations. For example in one test I needed to interact with a service. This can be done with the Angular TestBed:
TestBed.get(TargetService).init();
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
Inizia dalla documentazione dell’API di Angular Testing Library nella pagina RenderOptions collegata. Controlla l’esempio di declarations, aggiungi la descrizione mancante di providers e chiarisci quali opzioni vengono passate ad Angular TestBed e come TestBed può supportare i casi non standard. Il lavoro è completato quando gli esempi e le note esplicative coprono accuratamente questi punti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- angular
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100