qunitjs/qunit

Document QUnit.equiv()

Open

#1,778 opened on Jul 12, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (839 forks)batch import
Category: DocsType: Enhancementgood first issuehelp welcome

Repository metrics

Stars
 (4,008 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Has existed since 1.0.0. I'd consider it part of the "Extension interface" category.

Site source is in docs/. Get started locally: https://github.com/qunitjs/qunit/tree/main/docs#readme

See /test/main/equiv.js for examples of how it is works and how it is used. See also https://qunitjs.com/api/assert/deepEqual/, which is powered by this utility.

Contributor guide

Research direction
Add documentation for QUnit.equiv() in the docs folder. Refer to the existing extension interface docs and the test file at /test/main/equiv.js for examples. Also reference the deepEqual assertion which uses it.
Tech stack
javascript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
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