agentleFS
Sign inStart free
goravelgoravel/framework/AGENTS.md

framework

AGENTS.md532 starsChanged 4 years agoMITView on GitHub

Goravel (github.com/goravel/framework) is the framework core package, not an application. Application scaffold: goravel/goravel.

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 31,542 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.

The file

We split this AGENTS.md into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

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

    When asked to plan or investigate, produce a plan only — do not implement it until the user explicitly asks you to proceed.

    line 45
  2. Very specific:

    Use any instead of interface{}.

    line 49
  3. Very specific:

    Never edit mocks/ directly.

    line 50
  4. Distinctive:

    Follow standard Go formatting/naming.

    line 51
  5. Very specific:

    Never create errors inline in logic (fmt.Errorf, errors.New, etc.).

    line 52

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

Project Overview

Goravel (github.com/goravel/framework) is the framework core package, not an application. Application scaffold: goravel/goravel.

Common Commands

go test                                # unit tests
cd tests && go test ./...              # integration tests
go tool mockery                        # regenerate mocks
golangci-lint run                      # lint

Core Architecture

  • Main pattern: contracts/ -> module implementation -> facades/facades.go.
  • Each module uses service_provider.go with:
    • Register(app) for bindings
    • Boot(app) for post-registration setup
    • Relationship() for dependency order (ServiceProviderWithRelations)
  • IoC container: foundation/container.go (Bind, Singleton, BindWith, Instance, Make).
  • Binding registry: contracts/binding/binding.go.

Key Directories

  • contracts/: public interfaces.
  • foundation/: app bootstrap, container, provider repository.
  • facades/: static-style service access.
  • mocks/: generated testify mocks.
  • support/: shared utilities.
  • testing/: test helpers and framework.
  • tests/: integration test module.
  • packages/: package development support.

External Drivers

  • Route: goravel/gin, goravel/fiber
  • Database/ORM: goravel/mysql, postgres, sqlite, sqlserver
  • Cache/Session/Queue: goravel/redis
  • Storage: goravel/s3, oss, cos, minio

Planning Rules

  • When asked to plan or investigate, produce a plan only — do not implement it until the user explicitly asks you to proceed.

Code Rules

  • Use any instead of interface{}.
  • Never edit mocks/ directly; run go tool mockery to regenerate.
  • Follow standard Go formatting/naming; add comments where logic isn't self-evident. Go version is in go.mod.
  • Never create errors inline in logic (fmt.Errorf, errors.New, etc.). Declare all errors as named variables in errors/list.go using the framework's New(...) constructor. This centralises error messages to support future i18n.

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.

Check your setup, free