1 Commits
Author SHA1 Message Date
clawbot 7674efd2b1 Rewrite AGENTS.md sentence by sentence
check / check (push) Canceled after 0s
Rewrite the agent rules from scratch, with one idea per sentence and
every file name and command in backticks. Drop the rule that models
embed `models.Base`, which no package has. Say that the linter keeps
tests in external test packages, and that an `export_test.go` file
gives them access to unexported code. Limit the rules on doc comments
and blank imports to files outside the tests. State magic numbers as
a preference, and correct the blank-line rule for `return`. State the
branch workflow: pull requests target `next` and only the owner
merges `next` into `main`. Record the three snake_case JSON tags the
HTTP API keeps.

Part of #190.

Model: fable-5-1 (writing); opus-5-5 (rework)
2026-10-27 13:56:57 +00:00
+27 -19
View File
@@ -1,8 +1,9 @@
# Rules for coding agents
Rules for coding agents working in this repository. `CONVENTIONS.md` defines the
architecture and `REPO_POLICIES.md` the repository standards. Both are copies of
shared documents and are not edited here.
This file holds the rules for coding agents working in this repository.
`CONVENTIONS.md` defines the architecture. `REPO_POLICIES.md` defines the
repository standards. Both are copies of shared documents. Do not edit them
here.
## Before every commit
@@ -10,8 +11,8 @@ shared documents and are not edited here.
2. Run `make check`. It runs the tests and the linter in Docker, then the format
check. All three must pass with no findings.
Never run `go test`, `golangci-lint` or `gofmt` directly. The scripts in
`script/` hold the flags and the Docker setup.
Never run `go test`, `golangci-lint` or `gofmt` directly. Use the `make` targets
instead, such as `make test` and `make lint`.
## Branches and pull requests
@@ -25,26 +26,31 @@ Never run `go test`, `golangci-lint` or `gofmt` directly. The scripts in
## Code style
- Follow `CONVENTIONS.md`.
- Every package has a package doc comment. Every exported type, function, method
and variable has a doc comment.
- Outside test files, every package has a package doc comment.
- Outside test files, every exported type, function and variable has a doc
comment.
- JSON tags are camelCase. The HTTP API's `last_id`, `pow_token` and
`hashcash_bits` stay as they are, each with a `//nolint:tagliatelle` comment.
- No magic numbers. Use named constants.
- Prefer named constants to magic numbers. The `mnd` linter checks for them
outside test files.
- No inline error handling such as `if err := f(); err != nil`. Assign the error
on its own line, then test it.
- A blank line before every `return`.
- A `return` that follows another statement in its block has a blank line before
it.
- A blank line between the embedded fields of a struct and its other fields.
- Every blank import has a comment saying why it is there.
- Outside test files, every blank import has a comment saying why it is there.
## Architecture
- The server uses `go.uber.org/fx` for dependency injection. Each of its
components is an `fx` provider, wired together in `cmd/neoircd/main.go`.
- The server uses `go.uber.org/fx` for dependency injection.
`cmd/neoircd/main.go` lists its `fx` providers, such as `db.New` and
`handlers.New`.
- Application packages live under `internal/`, one package per concern.
`pkg/irc` holds the IRC command names and numeric reply codes.
- A handler method returns an `http.HandlerFunc`.
- A request struct is defined inside the handler that decodes it.
- Database access goes through the methods of `db.Database`.
- `pkg/irc` holds the IRC command names and numeric reply codes.
- The `web` package embeds the built web client.
- Each exported `Handle…` method of `Handlers` returns an `http.HandlerFunc`.
- A request struct is defined inside the method that decodes it.
- The server uses the database only through the methods of `db.Database`.
- The database migrations live in `internal/db/schema/` and are embedded with
`go:embed`.
- The database is SQLite, through the pure Go driver `modernc.org/sqlite`.
@@ -54,9 +60,11 @@ Never run `go test`, `golangci-lint` or `gofmt` directly. The scripts in
- Prefer table-driven tests.
- Use `testing.T` helpers, not assertion libraries.
- A test file lives next to the code it tests and ends in `_test.go`.
- Tests are in the package's external test package, such as `handlers_test`.
When a test needs an unexported name, an `export_test.go` file in the package
exposes it.
- The linter requires each test file to be in the package's external test
package, such as `handlers_test`. It allows `export_test.go` and files ending
in `_internal_test.go` in the package itself.
- An `export_test.go` file gives the external tests access to the package's
unexported code.
## Dependencies