Repository navigation
Add AI rules through agent docs - #563
Open
JieXiong9119 wants to merge 4 commits into
Open
JieXiong9119 wants to merge 4 commits into
JieXiong9119 wants to merge 4 commits into
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.
Any background context you want to provide?
Contributors increasingly use AI coding agents (GitHub Copilot, Claude Code, Codex, Cursor) on this repo. The rules for changing the schema are currently spread across
docs/versioning.md,docs/developer_resources.md,docs/release_instructions.md,proposals/README.md,.github/CONTRIBUTING.md, the PR template,.github/workflows/CI_Labels.yml,spec/validation_spec.rb, and the deprecation policy in the XSD header. Agents don't reliably find all of these, so they make avoidable mistakes such as breaking changes in minor releases, editingCHANGELOG.mdor the version in feature PRs, adding duplicate element names, or usingxs:complexContent.What does this PR do?
Adds one canonical rules file for AI agents, plus pointer files for each tool. Closes #562.
AGENTS.md(canonical): repo layout, commands, the six rules enforced byspec/validation_spec.rb, breaking/non-breaking/patch classification and the deprecation policy, the schema-change workflow (proposal, XSD, examples, linking docs, tests), PR rules (one change per PR, required labels, release cutoffs), and expected agent behavior..claude/CLAUDE.md: importsAGENTS.mdfor Claude Code..github/copilot-instructions.md: points Copilot toAGENTS.md..github/instructions/schema-xsd.instructions.md(applies toBuildingSync.xsd): structure, documentation and units, enumerations, ID/IDref,auc:Source/auc:Status,UserDefinedFields, and how to word deprecations..github/instructions/proposals.instructions.md(applies toproposals/**/*.md): where proposals go, how to name them, required sections, and what breaking proposals must discuss.All content comes from existing docs, workflows and tests, or from patterns already used in the XSD. No new policy is introduced. No changes to the schema, examples, tests or CI.
How should this be manually tested?
poetry run pre-commit run --all-filespasses.TightnesssimpleType). Check that it:CHANGELOG.mdor the version;bundle exec rake remove_tabs,bundle exec rakeandbundle exec rake generate_data_dictionary.AGENTS.mdresolve.What are the relevant tickets?
Screenshots (if appropriate)