agentleFS
OpenMindOpenMind/OM1/.github/copilot-instructions.md

OM1

Copilot instructions2.9k starsChanged 4 months agoMITView on GitHub

We split this copilot-instructions.md into the rules it gives an agent

17 rules. About 1 is common, 11 are distinctive, and 5 are very specific to this project.

  • ≈1

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈11

    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. Distinctive:

    Use these make commands:

    line 6
  2. Very specific:

    Test with coverage: make test-coverage

    line 9
  3. Very specific:

    Check all: make check (runs fmt, vet, lint, and test)

    line 14
  4. Very specific:

    When adding a new dependency, use go get <package> and run make deps to tidy.

    line 16
  5. Distinctive:

    Keep the dependency list minimal and prefer well-maintained packages.

    line 17
  6. Distinctive:

    Follow Go conventions and idiomatic patterns

    line 21
  7. Common:

    Use proper error handling (never ignore errors)

    line 22
  8. Distinctive:

    Follow the standard Go project layout

    line 23
  9. Very specific:

    Use gofmt for formatting (enforced by make fmt)

    line 24
  10. Distinctive:

    Keep business logic out of HTTP handlers

    line 29
  11. Distinctive:

    Use interfaces for abstractions

    line 30
  12. Distinctive:

    Use Go's built-in testing framework

    line 33
  13. Distinctive:

    Add unit tests for all new functions

    line 34
  14. Very specific:

    Run tests with race detector: make test

    line 36
  15. Distinctive:

    Use table-driven tests where appropriate

    line 37
  16. Distinctive:

    Write clear package documentation

    line 41
  17. Distinctive:

    Document exported functions and types

    line 42

≈ “Common” is an estimate: at least 1 in 5 of the 3,669 Copilot instructions 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
copilot-instructions.md

Copilot Instructions

Tooling / Dependencies

  • We use Make for building, testing, and running the project.
  • Dependencies are managed via Go modules (go.mod and go.sum).
  • Use these make commands:
    • Build: make build
    • Test: make test
    • Test with coverage: make test-coverage
    • Run: make run CONFIG=<config_name>
    • Dev mode: make dev CONFIG=<config_name>
    • Lint: make lint
    • Format: make fmt
    • Check all: make check (runs fmt, vet, lint, and test)
    • Clean: make clean
  • When adding a new dependency, use go get <package> and run make deps to tidy.
  • Keep the dependency list minimal and prefer well-maintained packages.

Coding Style

  • Use Go 1.21+
  • Follow Go conventions and idiomatic patterns
  • Use proper error handling (never ignore errors)
  • Follow the standard Go project layout
  • Use gofmt for formatting (enforced by make fmt)

Architecture

  • Use modular design
  • Separate concerns: inputs, actions, backgrounds, LLM providers
  • Keep business logic out of HTTP handlers
  • Use interfaces for abstractions

Testing

  • Use Go's built-in testing framework
  • Add unit tests for all new functions
  • Aim for 90% code coverage
  • Run tests with race detector: make test
  • Use table-driven tests where appropriate
  • Mock external dependencies using interfaces

Comments

  • Write clear package documentation
  • Document exported functions and types
  • Avoid obvious comments
  • Use godoc conventions

Download now (ZIP)

Trending

Quiet since July.thin dataabout the whole repository

Dec 2025: 0 mentionsJan 2026: 0 mentionsFeb 2026: 0 mentionsMar 2026: 0 mentionsApr 2026: 2 mentionsMay 2026: 0 mentionsJun 2026: 0 mentionsJul 2026: 1 mentionAug 2026: 0 mentionsSep 2026: 0 mentionsOct 2026: 0 mentionsNov 2026: 0 mentions
Dec 2025Jun 2026Nov 2026
Mentions a month of the OpenMind/OM1 repository that our weekly crawl found: only 4 in all, so this is a hint, not a trend. There is no adoption data for this file yet.
  • Where files are headingNew Copilot instructions files have more rules about branches and pull requests, and fewer about code style.

    Of the Copilot instructions files we read, the 2,297 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.

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.