Repository navigation
docs: add AGENT.md with project structure, commands, build/test/package guide - #10
Merged
Merged
Conversation
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds
AGENT.md, a reference doc for AI coding agents working on this repo.Contents:
koishi.ymlIntelliSense, snippets)src/,schemata/,snippets/,scripts/,.github/workflows/, plus a note thatschemata/*.json,snippets/*.json,out/and*.vsixare generated and git-ignored (edit the.yamlsources instead)yaml, ESLint,@vscode/test-electron, vscepackage.jsonscript table, then explicit Build / Test / Package / Debug sectionscursorAt → SchemaIndexresolution pipeline and its non-obvious gotchas (untyped-key fallback via indentation, empty value slots must read as value positions, per-request re-parsing)yarn test+yarn packageare CI gates, tag-driven releasesKept alongside the existing Chinese-language
AGENTS.md; this one is in English to match the rest of the repo's public docs.Verified locally:
yarn run compile,yarn run convert, andyarn run lintall pass.