agentleFS
MicrosoftKnown publishermicrosoft/XBOX-Godot-Sample/.github/skills/gdextension-hygiene/SKILL.md

gdextension-hygiene

Skill240 starsChanged 28 days agoMITView on GitHub

Run a Godot/GDExtension finish pass over the current diff: enforce headless GDScript validation, public API doc_classes coverage, docs/spec/sample/test synchronization, and registration or CMake follow-through. Triggers: hygiene pass, finish pass, validate diff completeness, godot addon hygiene, gdextension hygiene, preflight diff, final pass

The file

Show its rules and text

We split this skill into the rules it gives an agent

15 rules. About 0 are common, 7 are distinctive, and 8 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈7

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 8

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Start from the current diff or the user-specified files, not from a whole-repo audit.

    line 17
  2. Distinctive:

    Use the existing repo and path-scoped instructions before inventing new validation steps.

    line 19
  3. Very specific:

    If the user explicitly wants PR-feedback triage, use pr-feedback-loop first.

    line 20
  4. Very specific:

    If the user explicitly wants risky-diff pressure testing, use adversarial-review first.

    line 21
  5. Very specific:

    ensure public classes, methods, properties, signals, and enums stay reflected in addons\godot_gdk\doc_classes\*.xml

    line 32
  6. Very specific:

    ensure the related docs\<addon>\*.md, spec\gdext-<addon>.md, sample content, and tests stay aligned when behavior or script-visible API …

    line 34
  7. Distinctive:

    ensure registration and ownership are wired correctly

    line 37
  8. Very specific:

    ensure the relevant addon CMakeLists.txt includes the new files

    line 38
  9. Distinctive:

    run the existing debug build step that refreshes the sample copy when required by the path-scoped instructions

    line 40
  10. Distinctive:

    follow their current build and documentation patterns

    line 43
  11. Very specific:

    do not invent doc_classes requirements for addons that do not currently ship them

    line 44
  12. Very specific:

    If any docs\tutorials\\*.md was edited in this diff, verify the matching scene or script under the relevant sample\tutorial_gdk\, …

    line 47
  13. Very specific:

    If any script under sample\tutorial_gdk\, sample\tutorial_playfab\, sample\tutorial_integrated\, or sample\tutorial_gameinput\ was edited …

    line 54
  14. Distinctive:

    If the change is intentionally docs-only or sample-only (typo fix, comment polish, scene-tree node order that does not appear in any …

    line 59
  15. Distinctive:

    Run the narrowest existing validation that proves the change is complete.

    line 69

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

GDExtension Hygiene Skill

You are the repo-local gdextension-hygiene skill. Your job is to inspect the current diff and make sure the change is finished cleanly across the Godot-facing surfaces that usually drift apart.

Core rules

  • Start from the current diff or the user-specified files, not from a whole-repo audit.
  • Build the checklist from the touched surfaces instead of applying every rule blindly.
  • Use the existing repo and path-scoped instructions before inventing new validation steps.
  • If the user explicitly wants PR-feedback triage, use pr-feedback-loop first.
  • If the user explicitly wants risky-diff pressure testing, use adversarial-review first.

Finish-pass checklist

  • For .gd changes anywhere in the repo, run:
pwsh -NoLogo -NoProfile -ExecutionPolicy Bypass -File .\tools\check_gd_scripts_headless.ps1
  • For godot_gdk public contract changes:
    • ensure public classes, methods, properties, signals, and enums stay reflected in addons\godot_gdk\doc_classes\*.xml
    • ensure the related docs\<addon>\*.md, spec\gdext-<addon>.md, sample content, and tests stay aligned when behavior or script-visible API changes
  • For new native classes or source files:
    • ensure registration and ownership are wired correctly
    • ensure the relevant addon CMakeLists.txt includes the new files
  • For synced godot_gdk addon content under addons\godot_gdk\:
    • run the existing debug build step that refreshes the sample copy when required by the path-scoped instructions
  • For other addons:
    • follow their current build and documentation patterns
    • do not invent doc_classes requirements for addons that do not currently ship them
  • For tutorial / sample snippet drift (the hand-discipline backstop — there is no machine validator that holds tutorial prose and sample scripts in lockstep):
    • If any docs\tutorials\**\*.md was edited in this diff, verify the matching scene or script under the relevant sample\tutorial_gdk\, sample\tutorial_playfab\, sample\tutorial_integrated\ (or sample\tutorial_gameinput\ for the standalone GameInput track) was also touched in the same diff. The sample is the "this is what you should have" anchor for the tutorial reader, so a tutorial-only change is a drift smell unless the snippet genuinely matches what already ships.
    • If any script under sample\tutorial_gdk\, sample\tutorial_playfab\, sample\tutorial_integrated\, or sample\tutorial_gameinput\ was edited in this diff, verify the matching docs\tutorials\**\*.md was also touched. A sample-only change without the matching tutorial update silently walks the reader off the rails.
    • If the change is intentionally docs-only or sample-only (typo fix, comment polish, scene-tree node order that does not appear in any snippet, autoload refactor that does not change the snippet shape), call it out explicitly in the report so the reviewer can confirm the asymmetry is on purpose.

Workflow

  1. Identify the changed surfaces in the diff.
  2. Build the minimum finish-pass checklist that applies to those surfaces.
  3. Fix the missing follow-through directly when it is concrete and local.
  4. Run the narrowest existing validation that proves the change is complete.
  5. Report any remaining gaps that need a product or scope decision.

Output format

Use this structure:

  1. Scope
  2. Required follow-through
  3. Gaps fixed
  4. Remaining gaps
  5. Validation

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.