karma-runner/karma

The documentation needs work for begginers

Open

#1,315 创建于 2015年2月17日

在 GitHub 查看
 (9 评论) (0 反应) (0 负责人)JavaScript (11,918 star) (1,703 fork)batch import
help wantedtype: backlogtype: docs

描述

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.

贡献者指南

技术栈
javascriptnodejs
领域
documentationtesting
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
needs investigation
前置要求
JavaScriptKarma test runner
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
65
研究方向
First, review the current Karma documentation on the project's website (likely in the /docs folder) to identify sections that are unclear. Focus on the 'Usage' and 'Configuration' sections. Then, look at similar test runner documentation (e.g., Mocha, Jest) for inspiration on how to explain test execution and output interpretation. Consider adding screenshots and step by step guides. Finally, open a PR that updates the relevant documentation files.
The documentation needs work for begginers · karma-runner/karma#1315 | Good First Issue