mapbox / mapbox/probematch

matchLine tests and better documentation

Open
#5 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
19
Forks
4
PR merge metrics
No merged PRs in 30d

Description

maybe some assertions of properties that matchline outputs, and make it more obvious what matchLine output.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the matchLine implementation and checking its current output shape. Define assertions for the properties it returns and update the relevant documentation so the output is clear; done means the tests cover the agreed properties and the documentation explains matchLine output.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation, testing
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.