docs: add AGENTS.md agent operating guidance - #227
Open
andrewluxem wants to merge 1 commit into
Open
andrewluxem wants to merge 1 commit into
andrewluxem wants to merge 1 commit into
Conversation
Add a self-contained, vendor-neutral AGENTS.md so AI coding agents such as Claude Code, Codex, Cursor, and the @claude GitHub Action operate within clear safety boundaries for this RL-for-trading library. The guidance forbids live trading, order placement, broker/exchange or account mutations, secret handling, financial advice, performance claims, and guaranteed-return language. It documents the stack, protected surfaces, approval-gated commands, validation expectations, and the shared-upstream branch/contribution model. The repo intentionally git-ignores CLAUDE.md and .claude/, so those local maintainer files are not committed and the existing .gitignore convention is preserved. Docs-only. No source, tests, examples, package/config files, workflows, datasets, model artifacts, notebooks, generated outputs, trading logs, runtime files, or secrets changed. No install, test, training, backtest, data download, broker/exchange call, order placement, live trading, external API, release, publish, deploy, or automation action was run. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This branch has not been deployed
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
CLAUDE.mdand.claude/are git-ignored local maintainer tooling.Repo tailoring
Treats TorchTrade as a shared, multi-maintainer OSS RL-for-trading library.
Adds explicit financial/trading safety boundaries:
Names protected risk surfaces:
.envand credential variablesDocuments approval-gated commands and actions:
uv syncuv run pytestmkdocs serveNotes the existing
@claudeGitHub Action reads AGENTS.md, so AGENTS.md is the appropriate vendor-neutral shared agent guidance file.Validation
AGENTS.mdwas committed.CLAUDE.mdand.claude/remain ignored/untracked and were not force-added.git diff --cached --checkwas clean before commit.Safety
.envvalues, broker/exchange keys, account balances, portfolio data, private datasets, generated private outputs, or trading logs were inspected or printed.