testing-library / testing-library/testing-library-docs
Improve Angular Testing Library API documentation
未關閉
還沒有人認領這個 Issue。
- 主要語言
- JavaScript
- 星號
- 479
- 分支
- 740
- PR 合併指標
- 30 天內沒有已合併 PR
描述
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();
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
從連結的 RenderOptions 頁面上的 Angular Testing Library API 文件開始。檢查 declarations 範例,加入缺少的 providers 描述,並釐清哪些選項會傳遞給 Angular TestBed,以及 TestBed 如何支援非標準情況。當範例和說明性註解準確涵蓋這些要點時,即可視為完成。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- angular
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100