hemanth / hemanth/functional-programming-jargon

Organize for extensibility

Open
#223 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
18.7k
Forks
1k
PR merge metrics
No merged PRs in 30d

Description

I like a lot all that I read here - but -
I could not figure the logic of the order of the values in the index.

I think it's time to take a decision that will ensure the growth of this repo
Option 1 - sort values alphabetically

Pro: clear, neutral, streight forward. Con: less approachable: the narrative is lost

Option 2 - organize values in layers/chopters, each is organized internally by a narrative
Pro: able to tell the story and invite to dive deeper Con: it's prone to be disputed, and debated and could depend on personal style

I'll demonstrate:
e.g -

  • layer 1 - functional basics - pure function, arity, closure, idempotence, etc..
  • layer 2 - techniques - currying, contract, etc...
  • layer 3 - design patterns - continuation, functor, point-free, etc...

Personally I like better then 2nd option, but even I myself cannot make up my mind what comes first - techniques or design patterns, or how to divide between the two. 😛

But I do think that the basics would better come first...

I'd love to start a PR and work with you if I knew where to go with this :)

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

The issue does not name files, tests, or an entry point. First resolve whether the glossary should be alphabetized or organized into narrative layers, then identify the index structure and define the accepted ordering before making changes.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.