jwalsh/hy-algorithms

Create algorithm recipe cards

Open

#49 opened on Mar 29, 2025

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Hy (0 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (2 stars)
PR merge metrics
 (PR metrics pending)

Description

Develop a set of 'recipe cards' for algorithms and data structures:

Recipe card format:

  • Algorithm name and category
  • 'Ingredients' (prerequisites and components)
  • 'Preparation' (setup and initialization)
  • 'Cooking steps' (algorithm steps)
  • 'Serving suggestion' (use cases)
  • 'Nutrition facts' (time and space complexity)
  • 'Variations' (algorithm modifications)

Categories to cover:

  • Sorting algorithms
  • Searching algorithms
  • Graph algorithms
  • Dynamic programming
  • Data structures
  • String algorithms
  • Mathematical algorithms

Special features:

  • Visual representation of algorithm steps
  • Common gotchas and edge cases
  • Implementation tips
  • Before/after examples
  • Quick reference code in Hy

Distribution formats:

  • Printable cards
  • Digital collection
  • Online reference
  • Mobile-friendly version

These recipe cards will provide an intuitive, accessible format for algorithm reference, making complex algorithms more approachable through familiar metaphors and consistent presentation.

Contributor guide

Research direction
Review existing algorithm implementations in the repository and identify the format used. Consider starting with one algorithm category to create a sample card. Research available tools for creating visual representations and markdown formatting.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Over 1 week
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
AlgorithmsHyMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45