gum-issue-creation
Skill659 starsChanged 2 months agoMITView on GitHub
Conventions for filing GitHub issues in the Gum repo via gh. Triggers when the user asks to "log an issue", "create an issue", "file a bug", or otherwise capture a problem/idea as a GitHub issue (as opposed to fixing one).
In this repository69 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- debuggingSkill
- frb-build-verificationSkill
- frb-pixel-harnessSkill
- gum-architecture-layersSkill
- gum-bundleSkill
- gum-cliSkill
- gum-cross-platform-unificationSkill
- gum-docs-writingSkill
- gum-file-pathsSkill
- gum-forms-behaviorsSkill
- gum-forms-controlsSkill
- gum-forms-default-visualsSkill
- gum-forms-itemscontrolSkill
- gum-forms-theme-importSkill
- gum-iconsSkill
- gum-kernsmith-integrationsSkill
- gum-layout-engineSkill
- gum-layoutSkill
- gum-localizationSkill
- gum-monogame-renderingSkill
- gum-monthly-releaseSkill
- gum-project-versioningSkill
- gum-property-assignmentSkill
- gum-raylib-renderingSkill
- gum-releaseSkill
- gum-runtime-animation-chainsSkill
- gum-runtime-bindingSkill
- gum-runtime-fontsSkill
- gum-runtime-hot-reloadSkill
- gum-runtime-syntax-versionSkill
- gum-runtime-systemmanagers-initSkill
- gum-runtime-topologySkill
- gum-runtime-variable-referencesSkill
- gum-samplesSkill
- gum-serviceSkill
- gum-source-linked-projectSkill
- gum-themingSkill
- gum-tool-animationsSkill
- gum-tool-codegenSkill
- gum-tool-copy-pasteSkill
- gum-tool-delete-logicSkill
- gum-tool-dialogsSkill
- gum-tool-errorsSkill
- gum-tool-file-watchSkill
- gum-tool-font-generationSkill
- gum-tool-import-from-gumxSkill
- gum-tool-loggingSkill
- gum-tool-outputSkill
- gum-tool-pluginsSkill
- gum-tool-save-classesSkill
- gum-tool-screenshotsSkill
- gum-tool-selectionSkill
- gum-tool-tree-viewSkill
- gum-tool-undoSkill
- gum-tool-variable-gridSkill
- gum-tool-variable-referencesSkill
- gum-tool-viewmodelsSkill
- gum-unit-testsSkill
- gum-variable-deep-diveSkill
- The first 60 shown.
The file
We split this skill into the rules it gives an agent
6 rules. About 0 are common, 3 are distinctive, and 3 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈3
Distinctive · estimate
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 8
Use gh issue create to file issues.
- Distinctive: line 21
Suggested improvement: must not assert an unverified convention ("editors conventionally do X").
- Very specific: line 29
Use a real multi-line value for issue comments, issue bodies, and PR bodies.
- Very specific: line 46
After creating or editing a multi-line body, read it back before reporting success.
- Distinctive: line 49
Keep it scannable for a future implementer:
- Distinctive: line 58
After creating, report the issue URL back to the user.
≈ “Common” is an estimate: at least 1 in 5 of the 372,429 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Creating Gum Issues
Use gh issue create to file issues. Conventions:
Before researching the source pointer
Check the skills list for one matching the feature area and load it before grepping for the file:line pointer — CLAUDE.md's "load matching skills before investigating" rule applies to issue research too, not just edits. A matching skill (e.g. gum-tool-variable-grid for a Variables-tab/displayer report) names the relevant files and known gotchas directly instead of rediscovering them by grep.
Don't file
SokolGum and Maui are not maintained. Don't edit them, don't mention them in reports, PR bodies or briefs, don't file or work on issues that exist only for them, and a feature that ships on the MonoGame family, raylib, and Skia but not SokolGum is not a tracked gap.
FlatRedBall 1 (FRB1) is frozen. It changes only when a game that uses it needs a change, so don't file issues about behavior that is wrong only in the FRB1 build, and don't fix or pin it unprompted. Shared source still has to compile for FRB1 (the FRB canary), and #if FRB code is left alone.
Issues you file yourself
A value you printed while diagnosing something else is an observation, not a report — name what a user would see, or don't file. Say in the body that it came from instrumentation.
Suggested improvement must not assert an unverified convention ("editors conventionally do X"). Verify it or write it as an open question: asserted, it becomes the issue's premise, and whoever picks the issue up implements against it without rechecking.
Labels
- Bug reports get
--label bug(label exists, color#fc2929). Apply it at creation time. - The
buglabel is real and applies silently — don't second-guess it or omit it on later issues. - An issue that needs Vic's decision gets
--label "needs discussion"at creation (behavior changes that could move existing projects, open design questions). Vic finds his decision queue by this label.
Multi-line GitHub bodies
Use a real multi-line value for issue comments, issue bodies, and PR bodies. Never write literal \n sequences and expect GitHub Markdown to turn them into line breaks.
Match the syntax to the active shell. In PowerShell, use a here-string:
$githubBody = @'
...body...
'@
gh issue create --title "..." --body $githubBody --label bugIn Bash, use a heredoc or --body-file:
gh issue create --title "..." --body-file /tmp/issue_body.md --label bugAfter creating or editing a multi-line body, read it back before reporting success. Use gh issue view <number> --json body for issues and gh pr view <number> --json body for PRs.
Body structure
Keep it scannable for a future implementer:
- Problem — what's wrong / the user's report, verbatim intent preserved.
- Suggested improvement (when applicable) — concrete target behavior or message.
- Source — file:line pointer(s) found by a quick Grep, plus a one-line note on what the fix touches. A precise pointer turns a vague report into actionable work; spend a moment to find it.
- Reach — how a user lands on the broken code path, and whether that path is the recommended route or a legacy corner the tool never produces on its own. A defect reachable only through hand-authored input is near-zero impact; say so instead of letting it read like an ordinary bug.
Title
Specific and self-describing, phrased as what should be true (X should Y) rather than a description of the current problem, e.g. Animation keyframe "Could not find state or animation" error should name the missing reference, not a generic summary.
After creating, report the issue URL back to the user.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

