docs(skills): add community CTA section (star + issue, opt-in)#11
docs(skills): add community CTA section (star + issue, opt-in)#11anilcancakir wants to merge 2 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
Adds an optional community CTA section to the telescope skill, documenting when and how an agent may ask users to star the repository or file a telescope-side bug report.
Changes:
- Bumps the telescope skill from v0.0.2 to v0.0.3.
- Adds Section 8 in
SKILL.mdwith opt-in star and issue CTA triggers. - Adds a new community reference page and changelog entry describing the CTA flow,
ghpreflight, fallback URLs, diagnostics, and label rule.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
skills/fluttersdk-telescope/SKILL.md |
Adds the community CTA trigger matrix and reference link. |
skills/fluttersdk-telescope/references/community.md |
Defines the detailed star and issue workflows, diagnostics, commands, fallbacks, and spam brakes. |
CHANGELOG.md |
Records the new skill v0.0.3 community CTA documentation under Unreleased. |
| 7. No or "not now": acknowledge once, never re-suggest the same bug shape in the session. | ||
|
|
||
| ## Spam brakes (both flows) | ||
|
|
||
| - Star at most once per session. Issue at most once per unique bug shape per session. |
There was a problem hiding this comment.
Fixed in 8bb3043. references/community.md:115 now reads 'Issue at most once per session (one ask total, not one per bug shape)' to match SKILL.md Section 8 and the CHANGELOG. Step 7 of the Issue flow updated alongside: 'never re-suggest in the session (no second issue ask even on a different bug shape)'.
| ## Spam brakes (both flows) | ||
|
|
||
| - Star at most once per session. Issue at most once per unique bug shape per session. | ||
| - Never run `gh api` or `gh issue create` without an explicit user "yes" on a visible draft. |
There was a problem hiding this comment.
Fixed in 8bb3043. The visible-draft requirement is narrowed to gh issue create only. The Star flow's gh api --method PUT /user/starred/... just requires an explicit 'yes' to the prose ask, since no draft body exists to preview.
…er-session)
Skill v0.0.3. New SKILL.md Section 8 plus references/community.md let the
agent surface two CTAs at the end of a telescope-driven task:
- Star `fluttersdk/telescope` after the user confirms an end-to-end
success (captured HTTP record after a gesture, level-filtered tail
slice, surfaced uncaught exception, clear-then-repro delta, or clean
telescope:install).
- File an issue on `fluttersdk/telescope` only on a genuine telescope
bug: malformed MCP envelope, kInvalidParams for documented params,
TelescopeStore losing entries before the 500-cap, clear returning
anything but {"cleared": true}, shipped watchers throwing on a clean
install, telescope:install exiting non-zero on a fresh consumer, or
registerExtensionIdempotent violating idempotency.
Bug CTA explicitly excludes wired-but-empty buffers, swallowed
try/catch, consumer-app exceptions, raw dart:io HttpClient gaps, the
missing telescope_models MCP tool, and FIFO eviction past 500.
Both flows are prose-permission (no AskUserQuestion), max one star and
one issue per session, declining one suppresses only that CTA.
Preflight: `command -v gh && gh auth status`; gate failure prints the
URL only, never invokes open / xdg-open / start.
Labels: only `bug` is applied (the `agent-reported` label does not
exist on fluttersdk/telescope; the example drops the --label flag).
Copilot review on #11 flagged two consistency issues in references/community.md. 1. The spam brake said 'Issue at most once per unique bug shape per session' but SKILL.md Section 8 and the CHANGELOG both state 'max one star and one issue per session'. Tightened to the strict single-issue-per-session policy (less spammy, agrees with the surrounding docs). Step 7 of the Issue flow updated to match: 'never re-suggest in the session (no second issue ask even on a different bug shape)'. 2. The common spam brake required a visible draft before any gh call, but the Star flow only asks a yes/no with no draft body. Narrowed the visible-draft requirement to 'gh issue create' only; the Star flow's 'gh api PUT /user/starred/...' just needs an explicit yes to the prose ask.
7bb8efb to
8bb3043
Compare
Copilot review on #11 flagged two consistency issues in references/community.md. 1. The spam brake said 'Issue at most once per unique bug shape per session' but SKILL.md Section 8 and the CHANGELOG both state 'max one star and one issue per session'. Tightened to the strict single-issue-per-session policy (less spammy, agrees with the surrounding docs). Step 7 of the Issue flow updated to match: 'never re-suggest in the session (no second issue ask even on a different bug shape)'. 2. The common spam brake required a visible draft before any gh call, but the Star flow only asks a yes/no with no draft body. Narrowed the visible-draft requirement to 'gh issue create' only; the Star flow's 'gh api PUT /user/starred/...' just needs an explicit yes to the prose ask.
* docs(skills): add community CTA section (star + issue, opt-in, once-per-session)
Skill v0.0.3. New SKILL.md Section 8 plus references/community.md let the
agent surface two CTAs at the end of a telescope-driven task:
- Star `fluttersdk/telescope` after the user confirms an end-to-end
success (captured HTTP record after a gesture, level-filtered tail
slice, surfaced uncaught exception, clear-then-repro delta, or clean
telescope:install).
- File an issue on `fluttersdk/telescope` only on a genuine telescope
bug: malformed MCP envelope, kInvalidParams for documented params,
TelescopeStore losing entries before the 500-cap, clear returning
anything but {"cleared": true}, shipped watchers throwing on a clean
install, telescope:install exiting non-zero on a fresh consumer, or
registerExtensionIdempotent violating idempotency.
Bug CTA explicitly excludes wired-but-empty buffers, swallowed
try/catch, consumer-app exceptions, raw dart:io HttpClient gaps, the
missing telescope_models MCP tool, and FIFO eviction past 500.
Both flows are prose-permission (no AskUserQuestion), max one star and
one issue per session, declining one suppresses only that CTA.
Preflight: `command -v gh && gh auth status`; gate failure prints the
URL only, never invokes open / xdg-open / start.
Labels: only `bug` is applied (the `agent-reported` label does not
exist on fluttersdk/telescope; the example drops the --label flag).
* docs(skills): align community.md spam brakes with SKILL.md + CHANGELOG
Copilot review on #11 flagged two consistency issues in
references/community.md.
1. The spam brake said 'Issue at most once per unique bug shape per
session' but SKILL.md Section 8 and the CHANGELOG both state 'max
one star and one issue per session'. Tightened to the strict
single-issue-per-session policy (less spammy, agrees with the
surrounding docs). Step 7 of the Issue flow updated to match: 'never
re-suggest in the session (no second issue ask even on a different
bug shape)'.
2. The common spam brake required a visible draft before any gh call,
but the Star flow only asks a yes/no with no draft body. Narrowed
the visible-draft requirement to 'gh issue create' only; the Star
flow's 'gh api PUT /user/starred/...' just needs an explicit yes to
the prose ask.
Summary
Adds a star + issue CTA pattern to the telescope skill, mirroring
fluttersdk_duskv0.0.3. Both CTAs are opt-in, prose-permission, never auto-executed, max once per session.Stacked on #9: base is
docs/skills-sync. Once #9 merges, the base auto-rebases ontomaster.Changes
skills/fluttersdk-telescope/SKILL.md: bump v0.0.2 -> v0.0.3, add References row pointing atcommunity.md, add## 8. Communitysection (trigger matrix only, 16 lines + 1 row).skills/fluttersdk-telescope/references/community.md: NEW, 118 lines. Star + issue flows, preflight, fallback URLs, diagnostic-gather order, issue body skeleton, spam brakes.CHANGELOG.md: bullet under## [Unreleased]->### Added.Trigger split
clear-then-repro delta, or cleantelescope:install).kInvalidParamsfor documented params,TelescopeStorelosing entries before the 500-cap,clearreturning anything but{"cleared": true}, shipped watchers throwing on a clean install,telescope:installexiting non-zero on a fresh consumer, orregisterExtensionIdempotentviolating idempotency.The issue trigger explicitly excludes the documented wired-but-empty buffers, swallowed
try / catchinvisibility, consumer-app exceptions, rawdart:io HttpClientgaps, the missingtelescope_modelsMCP tool, and FIFO eviction past 500.Labels
The
agent-reportedlabel does not exist onfluttersdk/telescope(onlybugdoes). Thegh issue createexample incommunity.mddrops the--label agent-reportedflag and applies only--label bug. Both SKILL.md and CHANGELOG note this rule.Verification
grep -nP '[–—]'em-dash / en-dash sweep across all 3 files: 0 matches.fluttersdk/telescopeslug consistent across all 3 files.dart format/analyze/flutter testgates not applicable: skill-only change, nolib/touched.