agentleFS
openshift-engopenshift-eng/ai-helpers/.cursor/rules/idiomatic-go.mdc

ai-helpers / rules

Cursor rule121 starsChanged 12 months agoApache-2.0View on GitHub

When writing Go code, always follow the guidelines from Effective Go. See Effective Go for comprehensive guidelines and Go Code Review Comments for additional best practices.

We split this idiomatic-go.mdc into the rules it gives an agent

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

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    When writing Go code, always follow the guidelines from Effective Go.

    line 3
  2. Distinctive:

    Handle all errors explicitly: - never ignore error return values

    line 11
  3. Distinctive:

    Use defer for cleanup

    line 16

≈ “Common” is an estimate: at least 1 in 5 of the 6,350 Cursor rule 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
idiomatic-go.mdc
# Idiomatic Go Code

When writing Go code, always follow the guidelines from [Effective Go](https://go.dev/doc/effective_go).

## Required Actions

1. **Before writing any Go code**, reference https://go.dev/doc/effective_go and apply its principles
2. **Run `gofmt -w .`** on all Go files before committing
3. **Run `go vet`** to catch common mistakes
4. **Follow naming conventions**: MixedCaps for exported, mixedCaps for unexported
5. **Handle all errors explicitly** - never ignore error return values
6. **Use idiomatic patterns**:
   - Prefer small interfaces
   - Share memory by communicating (use channels)
   - Return errors, don't panic
   - Use defer for cleanup
   - Accept interfaces, return concrete types

## Common Anti-Patterns to Avoid

- Using `panic` for normal error handling
- Ignoring errors with `_`
- Communicating by sharing memory instead of using channels
- Large, unfocused interfaces
- Package names with underscores or mixedCaps
- Storing `context.Context` in structs

## Reference

See [Effective Go](https://go.dev/doc/effective_go) for comprehensive guidelines and [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments) for additional best practices.

Download now (ZIP)

  • Where files are headingNew Cursor rule files have more rules about planning and tracking tasks, and fewer about code style.

    Of the Cursor rule files we read, the 3,978 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repositoryOne other file it gives its agents.

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.