docs: add contributor guidance and refresh README#93
Merged
Conversation
Signed-off-by: Eduardo Silva <eduardo@chronosphere.io>
Signed-off-by: Eduardo Silva <eduardo@chronosphere.io>
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.
Summary
AGENTS.mdas the canonical, vendor-neutral repository operating guideCLAUDE.mdadapter that imports the canonical guideWhy
The README referenced the former repository location, advanced submodules with
--remote, and assumed an existing in-tree build directory. CTraces also had no repository-owned entry point for coding agents or canonical local verification command.This change makes public setup instructions reproducible and records verified architecture, ownership, compatibility, dependency, and validation rules in normal repository documentation without adding vendor-specific policy.
Impact
Users get current build, test, and installation instructions. Codex CLI, Claude Code, human contributors, CI, and future tools can follow the same repository-owned guidance and execute the same validation wrappers. Production source, public APIs, vendored code, generated files, submodules, tests, and CI behavior are unchanged.
Validation
cmake --installvalidationbash -n scripts/agent-build.sh scripts/agent-test.sh scripts/agent-verify.shctr-test-span: 1/1 passedscripts/agent-verify.sh: 4/4 tests passedCLAUDE.mdcontains only@AGENTS.mdgit diff --check