Skip to content

docs: unify template instructions around the plugin contract - #18

Merged
cchacs merged 1 commit into
mainfrom
pullfrog/15-unify-template-instructions
Oct 17, 2026
Merged

cchacs merged 1 commit into
mainfrom
pullfrog/15-unify-template-instructions

Conversation

@pullfrog

@pullfrog pullfrog Bot commented Oct 17, 2026

Copy link
Copy Markdown
Contributor

Summary

Closes #15. Makes AGENTS.md the single authoritative development guide and removes the contradictory corrections that lived in CLAUDE.md, so an agent following any one guide reaches the same decisions.

What changed

AGENTS.md (now authoritative) — adds and owns the load-bearing contract facts:

  • Contract sources table naming the spec repo (get-flashbacks/feedBack-plugin-spec) and Host repo (get-flashbacks/feedBack), each pinned to a reproducible revision (3d653d1, ff8984a) with links and a copy-paste verification command.
  • Spec vs. shipped Host subsection separating normative rules from observed behavior:
    • folder/id — the spec requires the directory name to equal id (§5.2/§4.2), while the shipped Host registers by manifest id regardless of folder name (folder name only feeds _is_bundled() for duplicate resolution);
    • the plugin-<id> screen container is Host-gated on bool(manifest.get("screen")) and the fetch path is hardcoded to screen.html.
  • Renaming this template into a real plugin checklist covering every hard-coded id.
  • Verification and completion criteria with exact setup/test commands (venv + pip install -r requirements-dev.txt + pytest -q), the custom-checks.yml steps, and the running-Host smoke checks.

CLAUDE.md — drops the "two corrections to AGENTS.md" section and defers to AGENTS.md; keeps the template-vs-plugin context and canonical repo links (casing fixed to feedBack-plugin-spec).

READMEs — the folder/id section no longer claims a mismatch "will not load" (it now distinguishes the spec requirement from Host leniency); the plugin-discovery directories are stated per spec §5.1 (plugins/, FEEDBACK_PLUGINS_DIR, Plugin Manager); settings storage is stated as <config_dir>/<id>.json; spec links canonicalized.

.gitignore / CHANGELOG.md — ignore the .venv/ the documented setup creates; changelog entry added.

Verification

  • pytest -q → 21 passed.
  • node --check my-plugin/screen.js → OK.
  • custom-checks.yml manifest validation → OK; no print( in routes.py.
  • Every documented contract claim checked against the pinned spec/Host revisions (fetched the named files and read them).

Docs-only change, so no behavioral surface to review beyond the accuracy of the cited contract claims.

Pullfrog  | View workflow run | via Pullfrog | Using big-pickle (free) | 𝕏

Make AGENTS.md the authoritative development guide: it now names the
spec and Host repositories with the pinned revisions this template was
verified against, separates normative spec rules from observed Host
behavior (folder/id handling and the screen-mount gate), adds a
copy/rename checklist, and states exact setup commands plus completion
criteria.

CLAUDE.md no longer carries corrections to AGENTS.md; it defers to it.
The READMEs drop the unsupported "folder/id mismatch will not load"
claim, name the Host's real plugin-discovery directories, and state the
settings store as <config_dir>/<id>.json. Spec links use the canonical
get-flashbacks/feedBack-plugin-spec name.
@kilo-code-bot

kilo-code-bot Bot commented Oct 17, 2026 •

Copy link
Copy Markdown

Code Review Summary

Status: No Issues Found | Recommendation: Merge

Files Reviewed (6 files)
  • .gitignore
  • AGENTS.md
  • CHANGELOG.md
  • CLAUDE.md
  • README.md
  • my-plugin/README.md

Reviewed by efficient · Input: 99.7K · Output: 18.4K · Cached: 338.8K

@cchacs
cchacs merged commit 1dca19c into main Oct 17, 2026
9 checks passed
@cchacs
cchacs deleted the pullfrog/15-unify-template-instructions branch October 17, 2026 03:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Unify template instructions around the actual plugin contract

1 participant