karma-runner/karma

The documentation needs work for begginers

オープン

#1,315 opened on 2015/02/17

GitHub で見るコントリビューターガイド
 (9 件のコメント) (0 件のリアクション) (0 人の担当者)JavaScript (1,703 件のフォーク)batch import
help wantedtype: backlogtype: docs

Repository metrics

Stars
 (11,918 個のスター)
PR merge metrics
 (PR metrics pending)

説明

After reading through the intro material and other pages on the webiste, I have no idea how to develop with karma. The most I can figure out from karma's website is how to start the karma server. After that, what do I do? How do i run tests in a way where I can step through code in the browser running the test?

Also, there is 0 documentation on how to interpret karma's output. It isn't self explanatory. Is everything that's outputting a failed test? How bout some screen shots that explain some of these things.

コントリビューターガイド

調査方針
まず、プロジェクトのウェブサイト（おそらく /docs フォルダ内）にある現在の Karma ドキュメントを確認し、不明確なセクションを特定します。「使用法」と「設定」セクションに焦点を当てます。次に、類似のテストランナー（例：Mocha、Jest）のドキュメントを参考に、テスト実行と出力解釈の説明方法についてインスピレーションを得ます。スクリーンショットとステップバイステップガイドの追加を検討します。最後に、関連するドキュメントファイルを更新する PR を開きます。
技術スタック
javascript
領域
testing
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
半日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Git
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80