diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bff7946..494533c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,13 @@ # Contributing + +## 中文摘要 + +- 用途:本文档围绕 `Contributing`,用于理解 `InteractiveBrokersPlatform` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖:`Ground Rules`、`Branching and Pull Requests`、`Local Verification`。 +- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。 Thanks for contributing to `InteractiveBrokersPlatform`. ## Ground Rules diff --git a/SECURITY.md b/SECURITY.md index 46764e9..0824cbe 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,5 +1,13 @@ # Security Policy + +## 中文摘要 + +- 用途:本文档围绕 `Security Policy`,用于理解 `InteractiveBrokersPlatform` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖:`Reporting a Vulnerability`、`Secret and Credential Exposure`、`Scope Notes`。 +- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。 Thanks for helping keep `InteractiveBrokersPlatform` safe. This repository is part of a runtime trading platform. Please do **not** open a public issue for vulnerabilities involving credentials, broker access, cloud resources, order execution, or secret material. diff --git a/docs/ibkr_paper_top50_switch.md b/docs/ibkr_paper_top50_switch.md index 22d71c0..456b89f 100644 --- a/docs/ibkr_paper_top50_switch.md +++ b/docs/ibkr_paper_top50_switch.md @@ -1,5 +1,13 @@ # IBKR Paper Top50 Balanced Switch Runbook + +## 中文摘要 + +- 用途:本文档围绕 `IBKR Paper Top50 Balanced Switch Runbook`,用于理解 `InteractiveBrokersPlatform` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖:`Safety Gates`、`Required Runtime Env`、`Rehearsal Sequence`、`Rollback`。 +- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。 This branch is for a paper-account rehearsal only. Do not use it for live IBKR. ## Safety Gates diff --git a/docs/superpowers/README.md b/docs/superpowers/README.md index ddf742e..a7201ee 100644 --- a/docs/superpowers/README.md +++ b/docs/superpowers/README.md @@ -1,5 +1,13 @@ # Historical agent plans and research notes + +## 中文摘要 + +- 用途:本文档围绕 `Historical agent plans and research notes`,用于理解 `InteractiveBrokersPlatform` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖:`Archived plans`、`Archived specs`。 +- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。 This directory is an archive of March 2026 agent-generated implementation plans and research designs. These files are useful for understanding why earlier IBKR research and runtime changes were attempted, but they are **not** the current source of truth for strategy behavior or live deployment settings. Current docs live here instead: diff --git a/docs/superpowers/plans/2026-03-28-remove-execution-lock.md b/docs/superpowers/plans/2026-03-28-remove-execution-lock.md index adb433b..eb02e1f 100644 --- a/docs/superpowers/plans/2026-03-28-remove-execution-lock.md +++ b/docs/superpowers/plans/2026-03-28-remove-execution-lock.md @@ -1,5 +1,13 @@ # Remove Execution Lock Implementation Plan + +## 中文摘要 + +- 用途:本文档围绕 `Remove Execution Lock Implementation Plan`,用于理解 `InteractiveBrokersPlatform` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖:`Task 1: Replace lock tests with in-memory-only behavior`、`Task 2: Remove persistent lock code`、`Task 3: Clean docs and verify`。 +- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。 > Historical note: this file is an agent planning/research archive from March 2026. It is not the current source of truth for strategy logic, cadence, live runtime configuration, or deployment state. Use `docs/superpowers/README.md` for the archive index and current documentation pointers. > **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking. diff --git a/research/README.md b/research/README.md index 2538dca..b67ebb6 100644 --- a/research/README.md +++ b/research/README.md @@ -1,5 +1,13 @@ # Research Notes + +## 中文摘要 + +- 用途:本文档围绕 `Research Notes`,用于理解 `InteractiveBrokersPlatform` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖:`Research Notes`。 +- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。 This directory keeps IBKR-side research artifacts that are still useful for current live strategy review.