Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (37 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

47 lines (37 loc) · 1.78 KB
Raw

Contributing

Thanks for improving home-omakase-skill. This repo ships a single agent skill; keep changes small, evidence-based, and safe.

The required contract

Any change to the skill must preserve these invariants:

  1. Food-safety rules stay intact. Every raw-fish path must keep the sashimi-grade + cold-chain + at-risk-population rules. Do not soften or remove them.
  2. Never fabricate sourcing facts. No invented vendors, prices, or "safe to eat raw" claims for a specific product. Region-specific channels are examples, not guarantees — phrase them as "confirm sashimi-grade with the vendor."
  3. The description is "when to use", not a workflow summary. Keep the SKILL.md frontmatter description focused on triggering conditions; never recite the steps there (it makes agents skip the body).
  4. Bump the version + CHANGELOG for any user-visible change (skills/home-omakase/CHANGELOG.md, frontmatter metadata.version, README badge). Use semver: patch = wording/fix, minor = new content/section, major = restructure.
  5. Keep SKILL.md ≤ 500 lines. Heavy material goes in references/.

PR checklist

  • Safety rules preserved (point 1–2 above)
  • Description is when-to-use only
  • Version + CHANGELOG bumped
  • Both README.md and README.zh-CN.md updated if behavior changed
  • SKILL.md still ≤ 500 lines

Commit & PR titles — Conventional Commits

feat: add kaiseki-only course template
fix: correct sushi-rice vinegar ratio
docs: clarify uni-as-offal ambiguity in fish guide
chore: bump to 0.2.0

Local layout

The install unit is skills/home-omakase/. The .claude-plugin/, .codex-plugin/, and .cursor-plugin/ manifests only carry metadata — skill content is auto-discovered from skills/.