testing-library / testing-library/testing-library-docs
Improve Angular Testing Library API documentation
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- JavaScript
- Sterne
- 479
- Forks
- 740
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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();
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der Angular Testing Library API-Dokumentation auf der verlinkten RenderOptions-Seite. Prüfe das declarations-Beispiel, füge die fehlende Beschreibung von providers hinzu und stelle klar, welche Optionen an Angular TestBed übergeben werden und wie TestBed nicht standardmäßige Fälle unterstützen kann. Als erledigt gilt die Aufgabe, wenn die Beispiele und erläuternden Hinweise diese Punkte korrekt abdecken.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- angular
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100