Skip to content

docs: add missing AGENTS.md (and README where missing)#33

Open
trly wants to merge 1 commit into
mainfrom
docs/update-repo-docs-e8d059bc-34c2-4ce5-aa71-9de7a2a1b92e
Open

docs: add missing AGENTS.md (and README where missing)#33
trly wants to merge 1 commit into
mainfrom
docs/update-repo-docs-e8d059bc-34c2-4ce5-aa71-9de7a2a1b92e

Conversation

@trly

@trly trly commented Jun 26, 2026

Copy link
Copy Markdown

Adds the missing root AGENTS.md for this repository (and a root README.md where one was also missing).

Generated by a batch change following the repository-documentation skill.

Created by Sourcegraph agentic batch change.

Comment thread AGENTS.md
Comment on lines +30 to +32
go build ./... # build all packages
go test ./... # run the full test suite (as in CI)
go vet ./... # static checks

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that is what you expect in a go project, no point documenting it

Suggested change
go build ./... # build all packages
go test ./... # run the full test suite (as in CI)
go vet ./... # static checks

Comment thread AGENTS.md
Comment on lines +19 to +20
Requires the Go toolchain matching `go.mod` (`go 1.25.9`).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Requires the Go toolchain matching `go.mod` (`go 1.25.9`).

what you would expect, no point wasting context pointing it out.

Comment thread AGENTS.md
**experimental** Go library for reading JSON Schema (draft-07) documents and
generating Go types from them.

## Layout

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this repo is so small I wonder how useful documenting this is

Comment thread AGENTS.md
The official test suite is vendored as a git submodule. After cloning, run:

```sh
git submodule update --init --recursive

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is useful information! Same with conventions below

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants