Skip to content

docs: add contributor guidance and refresh README#93

Merged
edsiper merged 2 commits into
masterfrom
docs/ai-operating-layer
Jul 13, 2026
Merged

docs: add contributor guidance and refresh README#93
edsiper merged 2 commits into
masterfrom
docs/ai-operating-layer

Conversation

@edsiper

@edsiper edsiper commented Jul 13, 2026

Copy link
Copy Markdown
Member

Summary

  • rewrite the README with current repository URLs, pinned submodule setup, out-of-source CMake commands, verified options, tests, installation, dependencies, and contribution links
  • add AGENTS.md as the canonical, vendor-neutral repository operating guide
  • add a one-line CLAUDE.md adapter that imports the canonical guide
  • document investigation, bug-fix, code-review, and cross-repository workflows
  • add small reusable CMake/CTest build, test, and verification wrappers

Why

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

  • README link validation
  • README CMake configure and build commands
  • README CTest command: 4/4 tests passed
  • staged cmake --install validation
  • bash -n scripts/agent-build.sh scripts/agent-test.sh scripts/agent-verify.sh
  • ShellCheck on all three scripts
  • targeted build and ctr-test-span: 1/1 passed
  • scripts/agent-verify.sh: 4/4 tests passed
  • documentation link validation
  • verified CLAUDE.md contains only @AGENTS.md
  • git diff --check

Signed-off-by: Eduardo Silva <eduardo@chronosphere.io>
@edsiper edsiper marked this pull request as ready for review July 13, 2026 03:33
Signed-off-by: Eduardo Silva <eduardo@chronosphere.io>
@edsiper edsiper changed the title docs: add repository AI operating guide docs: add contributor guidance and refresh README Jul 13, 2026
@edsiper edsiper merged commit f3abdda into master Jul 13, 2026
22 checks passed
@edsiper edsiper deleted the docs/ai-operating-layer branch July 13, 2026 14:27
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.

1 participant