tc39/test262

Helpers should be documented in or from CONTRIBUTING.md

Open

#3,918 opened on Sep 12, 2023

View on GitHub
 (2 comments) (2 reactions) (0 assignees)JavaScript (2,073 stars) (469 forks)batch import
help wanted

Description

There is no mention in CONTRIBUTING.md of compareArray or the other helpers, let alone how or when to incorporate them.

Contributor guide

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.
2
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
Basic JavaScript knowledgeFamiliarity with test262 helpers
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Review the CONTRIBUTING.md file at the root of the repository. Locate where `compareArray` and similar helper functions are defined, likely in the test suite's shared helper files. Add a new section in CONTRIBUTING.md that describes each helper's purpose and how to use them. Check the issue comments for any additional context or preferences from maintainers.