Files
timmy-config/CONTRIBUTING.md

1.4 KiB

Contributing to timmy-config

Proof Standard

This is a hard rule.

  • visual changes require screenshot proof
  • do not commit screenshots or binary media to Gitea backup unless explicitly required
  • CLI/verifiable changes must cite the exact command output, log path, or world-state proof showing acceptance criteria were met
  • config-only changes are not fully accepted when the real acceptance bar is live runtime behavior
  • no proof, no merge

How to satisfy the rule

Visual changes

Examples:

  • skin updates
  • terminal UI layout changes
  • browser-facing output
  • dashboard/panel changes

Required proof:

  • attach screenshot proof to the PR or issue discussion
  • keep the screenshot outside the repo unless explicitly asked to commit it
  • name what the screenshot proves

CLI / harness / operational changes

Examples:

  • scripts
  • config wiring
  • heartbeat behavior
  • model routing
  • export pipelines

Required proof:

  • cite the exact command used
  • paste the relevant output, or
  • cite the exact log path / world-state artifact that proves the change

Good:

  • python3 -m pytest tests/test_x.py -q2 passed
  • ~/.timmy/timmy-config/logs/huey.log
  • ~/.hermes/model_health.json

Bad:

  • "looks right"
  • "compiled"
  • "should work now"

Default merge gate

Every PR should make it obvious:

  1. what changed
  2. what acceptance criteria were targeted
  3. what evidence proves those criteria were met

If that evidence is missing, the PR is not done.