-
Notifications
You must be signed in to change notification settings - Fork 8
docs: add missing AGENTS.md (and README where missing) #33
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
trly
wants to merge
3
commits into
main
Choose a base branch
from
docs/update-repo-docs-e8d059bc-34c2-4ce5-aa71-9de7a2a1b92e
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| # AGENTS.md | ||
|
|
||
| Guidance for coding agents working in `github.com/sourcegraph/go-jsonschema`, an | ||
| **experimental** Go library for reading JSON Schema (draft-07) documents and | ||
| generating Go types from them. | ||
|
|
||
| ## Layout | ||
|
|
||
| - `jsonschema/` — core library: schema types, parsing, walking, URI handling. | ||
| - `compiler/` — generates Go source from JSON Schemas (parser, resolver, | ||
| generators); golden-file fixtures live in `compiler/testdata/`. | ||
| - `cmd/go-jsonschema-compiler/` — CLI that emits Go types from schema files. | ||
| - `internal/` — test helpers (`testutil`) and the official JSON Schema test | ||
| suite runner (`jsonschematestsuite`). | ||
| - `testdata/` — shared schema fixtures (e.g. the draft-07 meta-schema). | ||
|
|
||
| ## Setup | ||
|
|
||
| The official test suite is vendored as a git submodule. After cloning, run: | ||
|
|
||
| ```sh | ||
| git submodule update --init --recursive | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this is useful information! Same with conventions below |
||
| ``` | ||
|
|
||
| ## Build, test, run | ||
|
|
||
| ```sh | ||
| go run ./cmd/go-jsonschema-compiler -pkg schema -o out.go schema.json | ||
| ``` | ||
|
|
||
| The CLI accepts one or more JSON Schema files; `-pkg` sets the emitted package | ||
| name and `-o` writes to a file instead of stdout. | ||
|
|
||
| ## Conventions | ||
|
|
||
| - Standard Go formatting (`gofmt`); generated output is run through | ||
| `go/format`. | ||
| - Compiler tests are golden-file based: each `compiler/testdata/<case>/` holds a | ||
| `schema.json` input and a `want.go` expected output. Update the corresponding | ||
| `want.go` when intentionally changing generated code. | ||
| - CI (`.github/workflows/go-ci.yml`) checks out submodules recursively and runs | ||
| `go test ./...`; keep that command green. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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