sinonjs/sinon

Name differences

Open

#1,509 opened on Aug 3, 2017

View on GitHub
 (3 comments) (0 reactions) (0 assignees)JavaScript (764 forks)batch import
Difficulty: MediumHelp wantedhacktoberfestpinned

Repository metrics

Stars
 (9,548 stars)
PR merge metrics
 (Avg merge 6d 16h) (15 merged PRs in 30d)

Description

It might be logical reasons that I don't know about, but I wonder about some of the name differences between sinon-methods:

spy.notCalledWith assert.neverCalledWith

Should they have the same name?

stub.callsFake stub.callsArg stub.callsArgWith stub.callThrough stub.callArg stub.callArgWith

I often end up checking the docs where there is 'calls*' and where there is 'call*'.

Contributor guide

Research direction
Examine the current naming patterns in sinon methods and propose a consistent naming scheme. Check historical decisions and update documentation accordingly.
Tech stack
javascript
Domain
developer experience
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80