NextCommerceCo / NextCommerceCo/spark

Publish the app-hook contract and clean starter defaults

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

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
0
Forks
1
Avg merge
9h 52m
Merged PRs (30d)
18

Description

Problem: Spark has 10+ {% app_hook %} sites but no published contract, so an app developer must grep the theme to discover them. The public theme docs document only two global hooks. Separately, the public schema ships one merchant-specific metadata key as a default, and PLAN.md disagrees with the README on the Web Component count.

Evidence: hook sites across layouts/base.html, templates/catalogue/product.html, partials/product_card.html, templates/index.html; TODOS.md:26-31 (promote the hook list to a documented public contract); configs/settings_schema.json:827 and layouts/base.html:208 (merchant-specific default); PLAN.md:15 (five vs six components).

Done when:

  • The hook inventory is published in Spark docs with naming conventions and a versioning policy.
  • The membership metadata key default is neutral, with the old value documented as a migration note.
  • PLAN.md matches the shipped component count.

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

Read the hook sites in layouts/base.html, templates/catalogue/product.html, partials/product_card.html, and templates/index.html, then compare them with TODOS.md:26-31 and the existing theme docs. Review configs/settings_schema.json:827, layouts/base.html:208, PLAN.md:15, and the README. Done means the hook contract, naming and versioning policy are published, the metadata default is neutral with a migration note, and the component count agrees.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, tailwindcss
Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.