agentleFS
tykisgodtykisgod/quick-question/skills/best-practice/SKILL.md

best-practice

Skill12 starsChanged 8 months agoMITView on GitHub

Quick Unity best-practice check — run after editing C# files to catch anti-patterns, performance issues, and runtime safety problems.

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

12 rules. About 0 are common, 7 are distinctive, and 5 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.

  • 5

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    If qq-policy-check.sh is available, run it first against the selected scope:

    line 24
  2. Distinctive:

    Treat those results as established findings — don't rediscover them.

    line 30
  3. Very specific:

    Every += needs a matching -= (subscribe in OnEnable, unsubscribe in OnDisable)

    line 86
  4. Very specific:

    If Awake/Start calls GetComponent<T>() and the result is used without null check, the class should have [RequireComponent(typeof(T))]

    line 90
  5. Very specific:

    Check that new using directives do not violate the project's established dependency direction

    line 95
  6. Distinctive:

    If a file uses a namespace from another Service module, verify the corresponding .asmdef reference exists

    line 98
  7. Distinctive:

    Check that namespaces follow the project's established naming scheme

    line 102
  8. Very specific:

    Run qq-policy-check.sh --json if available

    line 141
  9. Distinctive:

    Read all relevant .cs files

    line 142
  10. Distinctive:

    Check the rules above, treating deterministic policy findings as already established

    line 143
  11. Distinctive:

    If critical issues are found, ask whether to auto-fix them

    line 145
  12. Distinctive:

    After the check completes, recommend the next step:

    line 149

≈ “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

Run qq scripts as ${CLAUDE_PLUGIN_ROOT}/bin/<name>: they are not on PATH, so a bare qq-policy-check.sh exits 127.

Respond in the user's preferred language (detect from their recent messages, or fall back to the language setting in CLAUDE.md).

Quick best-practice check for Unity C# code: anti-patterns, performance traps and runtime safety issues in what just changed.

Arguments: $ARGUMENTS

With --auto, first make sure a pipeline tracks this run, so the handoff at the end can advance it: qq-execute-checkpoint.py pipeline-start --project . --type feature --current-skill "/qq:best-practice" --branch "$(git branch --show-current)" --if-not-running. It starts one only when none is running here (you were invoked on your own) and leaves a running one alone.

Scope Detection

  1. If the user specified files or a scope → use that
  2. If .cs files were edited in this conversation → check those files
  3. If there are uncommitted changes → git diff --name-only HEAD -- '*.cs'
  4. If none of the above → ask the user what to check

Deterministic Policy Layer

If qq-policy-check.sh is available, run it first against the selected scope:

qq-policy-check.sh --json <files...>

Treat those results as established findings — don't rediscover them; add contextual review, prioritization, explanation and fix suggestions on top.

Review Rules

Anti-Pattern Detection

  1. FindObjectOfType / FindObjectsOfType
    • Severity: High
    • Alternative: use the appropriate Registry/Manager singleton for your project
    • Exception: Editor code (Assets/Editor/, inside #if UNITY_EDITOR blocks) may use these
  2. Message system calls with untyped object[] parameters
    • Severity: Medium
    • Alternative: strongly-typed interfaces or events
  3. Accessing shared data in Awake/Start
    • Severity: High
    • Alternative: implement the appropriate lifecycle interface and access data in the ready callback
  4. Caching a read-only interface reference then mutating through it
    • Severity: High
    • Alternative: read-only access only
  5. SendMessage / BroadcastMessage / SendMessageUpwards
    • Severity: Medium
    • Alternative: C# events, UnityEvents, or interface-based dispatch
  6. Unsolicited UI code changes
    • Severity: Notice
    • UI code should not be modified unless the user explicitly requested it

Performance

  1. GetComponent in Update / FixedUpdate / LateUpdate
    • Severity: High
    • Alternative: cache component references in Awake/Start or use [SerializeField]
    • Also flag GetComponent inside OnCollision*, OnTrigger*
  2. Per-frame heap allocations
    • Severity: High
    • Flag inside Update/FixedUpdate/LateUpdate: new List, new Dictionary, string + or $"" interpolation, .ToString(), LINQ queries (.Where, .Select, .ToList), lambda closures
    • Alternative: pre-allocate and reuse, use StringBuilder, use non-alloc APIs
  3. Coroutines started without cleanup
    • Severity: High
    • StartCoroutine without a matching StopCoroutine / StopAllCoroutines in OnDisable (orphaned when pooled or re-enabled)
    • Alternative: cache coroutine references, stop in OnDisable
  4. gameObject.tag == string comparison
    • Severity: Medium
    • Alternative: use CompareTag() (allocation-free)

Runtime Safety

  1. Event subscription without unsubscription
    • Severity: High
    • Every += needs a matching -= (subscribe in OnEnable, unsubscribe in OnDisable)
  2. Missing [RequireComponent] for GetComponent dependencies
    • Severity: Medium
    • If Awake/Start calls GetComponent<T>() and the result is used without null check, the class should have [RequireComponent(typeof(T))]

Architecture Checks

  1. Circular dependency risk
    • Check that new using directives do not violate the project's established dependency direction
  2. Missing .asmdef references
    • If a file uses a namespace from another Service module, verify the corresponding .asmdef reference exists
  3. Incorrect namespace conventions
    • Severity: Medium
    • Check that namespaces follow the project's established naming scheme
  4. Public fields instead of [SerializeField] private
    • Severity: Medium
    • Alternative: [SerializeField] private for Inspector-assigned fields

Code Quality

  1. Excessive null checks
    • Minimal null checks; rely on exceptions to surface problems. Validate only at system boundaries (user input, external APIs)
  2. Missing documentation comments
    • Public classes and complex methods should have summary comments

Project rules

Also apply the project's own coding rules from CLAUDE.md and AGENTS.md (read AGENTS.md if it exists).

Output Format

Group output by severity:

## 🔴 Critical (High severity — must fix)
- [file:line] Issue description → suggested fix

## 🟠 Moderate (Medium severity — should fix)
- [file:line] Issue description → suggested fix

## 🟡 Suggestions (Notice — nice to fix)
- [file:line] Issue description → suggested fix

## ✅ Code Quality Highlights
- Brief list of things done well

Execution

  1. Determine scope (see Scope Detection above)
  2. Run qq-policy-check.sh --json if available
  3. Read all relevant .cs files
  4. Check the rules above, treating deterministic policy findings as already established
  5. Merge deterministic findings with model findings in the output format above
  6. If critical issues are found, ask whether to auto-fix them

Handoff

After the check completes, recommend the next step:

  • No issues found → "Clean. Want to run /qq:test to verify, or /qq:claude-code-review for a deeper review?"
  • Issues found and fixed → "Fixed N issues. Proceed to /qq:test?"
  • Issues found, user declined fix → "N issues remain. Proceed to /qq:test anyway, or fix first?"

--auto mode: skip asking, take the strictest path: auto-fix all issues, then run qq-execute-checkpoint.py pipeline-advance --project . --completed-skill "/qq:best-practice" --next-skill "/qq:claude-code-review", then invoke /qq:claude-code-review --auto.

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.