Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Move the OpenRecipe format into its own open-source repo

Open
  • Is something wrong?
#100 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
nodejs, typescript
Domain
build-system, developer-experience

Research direction

Start with tracking issue #101 and the format split and specification it describes; this issue says the repository move should happen after those are settled. Then review the format’s spec, schema, fixtures, and TypeScript reference implementation. Done means those are in a public repository and published package, OpenSkillet consumes a pinned version and runs conformance fixtures in CI, and licensing and the spec-change process are documented.

Written by the indexing model from the issue text.

Description

enhancement

Summary

Part of the OpenRecipe format extraction (tracking: #101). Do this after the format is split out and specified, ideally once its shape has settled.

Move the format into its own public repository so other projects can adopt it and give feedback, with OpenSkillet consuming it like any other user.

Scope

  • New repo containing SPEC.md, JSON Schema, conformance fixtures, and the TypeScript reference implementation.
  • Publish to npm (e.g. @openrecipe/format); OpenSkillet pins a version. Prefer a package over a git submodule. Use npm link or a git dependency for local iteration.
  • OpenSkillet CI runs the conformance fixtures against the pinned version.
  • Licensing: CC-BY or CC0 for the spec text, MIT for the code.
  • Feedback process: issue templates for spec proposals (lightweight RFCs), CONTRIBUTING.md.

Open questions

  • Naming: check for collisions (an older "Open Recipe Format" project exists). Possibly rename this repo to OpenSkillet and give the format the OpenRecipe name.
  • Positioning against prior art (Cooklang, schema.org/Recipe, RecipeML). Likely angle: a format designed to be diffed, forked and merged, with explicit licensing.
  • Import/export to schema.org Recipe JSON-LD as an adoption bridge: in the format library or the app?

Acceptance criteria

  • Public repo with spec, fixtures, reference implementation, and license.
  • Package published; OpenSkillet depends on it instead of in-tree code.
  • Spec-change process documented.
Dominant language
TypeScript
Stars
1
Forks
0
Avg merge
10h 51m
Merged PRs (30d)
48

Getting set up

  • Ships a Dockerfile or Docker Compose file
  • No pull request template
  • No 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.

More from dnerever/OpenRecipe

All issues in dnerever/OpenRecipe

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.