lambdaisland / lambdaisland/kaocha

Document combinator-matchers

Open
#228 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Clojure
Stars
860
Forks
81
PR merge metrics
No merged PRs in 30d

Description

Our combinator-matchers support is "bring your own," but this is not documented anywhere. Nor do we have much description of this feature or how it works. I suspect it's pretty self-explanatory if you're familiar with matcher-combinators, but I think we need to at least point people in the right direction.

Contributor guide

No contributing guide indexed for this repository

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 existing documentation and references to combinator-matchers, then review matcher-combinators for the behavior this project expects users to provide themselves. Done means the documentation explains what the feature is, how it works, and where users can learn how to use it.

Written by the indexing model from the issue text.

Assessment

Tech stack
clojure
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.