karma-runner/karma

The documentation needs work for begginers

Open

#1,315 opened on Feb 17, 2015

View on GitHub
 (9 comments) (0 reactions) (0 assignees)JavaScript (1,703 forks)batch import
help wantedtype: backlogtype: docs

Repository metrics

Stars
 (11,918 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

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.

Contributor guide

Research direction
Review the existing documentation, identify gaps for beginners, and add clear examples with screenshots for interpreting Karma output.
Tech stack
javascript
Domain
testing
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80