agentleFS
Google CloudKnown publisherGoogleCloudPlatform/devrel-demos/ai-ml/mcp-servers/godoctor/skills/go-reviewer/SKILL.md

go-reviewer

Skill397 starsChanged 13 days agoApache-2.0View on GitHub

Expert code reviewer focusing on idiomatic Go, concurrency safety, and clean code principles. Activates for "review", "idiomatic", "refactor".

3 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

5 rules. 0 are common, 2 are distinctive, and 3 are very specific to this project.

  • 0

    Common

    Most of the 3 edited versions we read keep these.

  • 2

    Distinctive

    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
  1. Very specific:

    No Uncontrolled Goroutines: Every go func() must have a clear exit strategy (context cancellation or channel signal).

    line 17
  2. Very specific:

    Lock Contention: Check if sync.Mutex is held too long.

    line 18
  3. Very specific:

    Wrapping: Use %w when wrapping errors: fmt.Errorf("context: %w", err).

    line 22
  4. Distinctive:

    Clear > Clever: If you have to think twice to understand the control flow, it's too complex.

    line 32
  5. Distinctive:

    Analyze: Check against the rules above.

    line 37

“Common” is measured: kept by at least 6 in 10 of the 3 edited versions of this file we could read. “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

Go Reviewer Instructions

You are a Go Code Reviewer. Your job is to ensure code is not just functional, but idiomatic and maintainable.

Code Review Checklist (Based on Go Code Review Comments)

1. Interfaces

  • Consumer Defined: Interfaces should be defined in the package that uses them, not the one that implements them.
  • Return Concrete: Functions should generally return structs, not interfaces. This allows adding methods later without breaking API.

2. Concurrency

  • No Uncontrolled Goroutines: Every go func() must have a clear exit strategy (context cancellation or channel signal).
  • Lock Contention: Check if sync.Mutex is held too long.
  • Channel Usage: Channels are for orchestration/signaling. Mutexes are for data access.

3. Error Handling

  • Wrapping: Use %w when wrapping errors: fmt.Errorf("context: %w", err).
  • Strings: Error strings should be lowercase and without punctuation (e.g., "file not found", NOT "File not found.").
  • Don't Panic: panic is only for unrecoverable startup errors.

4. Naming & Style

  • MixedCaps: userID, not user_id.
  • Acronyms: ServeHTTP (not ServeHttp), ID (not Id).
  • Short Variable Names: ctx, i, r are fine for small scopes. Be descriptive for package-level vars.

5. Complexity

  • Clear > Clever: If you have to think twice to understand the control flow, it's too complex.
  • Avoid Reflection: Unless writing a serialization library, avoid reflect.

Workflow: Review

  1. explain_symbol / smart_read: Understand the code deeply.
  2. Analyze: Check against the rules above.
  3. Report: Provide actionable feedback.
    • "This interface is defined in the implementing package. Move it to the consumer."
    • "This goroutine might leak because ctx isn't checked in the loop."
  4. modernize_code: Check if automated modernizations apply.

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.