testing-library / testing-library/testing-library-docs

Improve Angular Testing Library API documentation

オープン
#653 コメント 5 件 リアクション 2 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
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. 🙂

  1. 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
  2. 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.
  3. 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();

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

リンク先の RenderOptions ページにある Angular Testing Library API ドキュメントから始めてください。declarations の例を確認し、不足している providers の説明を追加して、どのオプションが Angular TestBed に渡されるのか、また TestBed が標準外のケースをどのようにサポートできるのかを明確にしてください。例と説明用の注記でこれらの点が正確にカバーされていれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
angular
領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。