Skip to content

Contributing

Jeremy Longworth edited this page Sep 12, 2026 · 2 revisions

Contributing

ChefSkills prioritizes small, reviewable culinary skill changes over bulk-generated content. A useful contribution makes a decision easier to inspect, route, validate, or safely decline.

Good contributions

  • improve a skill's decision criteria, workflow, or output contract
  • add a focused reference that changes agent behavior
  • add realistic scenarios with expected routing
  • tighten safety guidance with cited, reviewable reasoning
  • improve validators, evaluation tooling, or documentation

Avoid large recipe dumps, unreviewed food-safety claims, generic cooking advice, and new skills that duplicate an existing skill's responsibility.

Contribution flow

  1. Open or link an issue when the change affects routing, safety, evaluation scope, or a new specialist skill.
  2. Keep the pull request small enough to review against one behavior or milestone.
  3. Update tests/scenarios/ and tests/expected-routing.yaml when routing changes.
  4. Update catalog cases, state examples, fixtures, reports, and scorecards when behavior expectations change.
  5. Regenerate evaluation/scorecards/summary.json when scorecards change.
  6. Update public documentation or release notes when reader expectations change.
  7. Run validation before opening the pull request.

Skill quality bar

Each skill should include concise frontmatter, a focused workflow, an output contract, at least one reference file, and OpenAI agent metadata. Behavior changes should have matching scenario or evaluation evidence when practical.

Validation

.\scripts\validate-all.ps1

The GitHub Actions workflow runs the same validation suite on pushes and pull requests.

Issue forms and pull requests

Use the closest issue form for routing bugs, skill proposals, food-safety concerns, or evaluation fixture ideas. Pull requests should explain the behavior changed, routing and safety impact, source-check needs, evaluation updates, and validation evidence.

Templates: .github/ISSUE_TEMPLATE/

Read the repository contribution guide and Code of Conduct before contributing.

Clone this wiki locally