From 62dae15e801ad9b4c77540670419bb24223419a5 Mon Sep 17 00:00:00 2001 From: Pigbibi <20649888+Pigbibi@users.noreply.github.com> Date: Wed, 7 Oct 2026 01:48:37 +0800 Subject: [PATCH] docs: de-templatize README ordering and governance docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Move the QSL architecture role field list after the human-readable "What this repository is" section in README.md/README.zh-CN.md, and drop the repeated "中文摘要" meta block from CONTRIBUTING.md, SECURITY.md, and CODE_OF_CONDUCT.md. One substantive risk note (verify strategy/automation/credential/cloud/broker/exchange changes before production) is folded into CONTRIBUTING.md's Ground Rules instead of being dropped. Also de-duplicates a repeated "延伸文档" heading in README.zh-CN.md. No code, config, or workflow logic changes. Co-Authored-By: Claude Sonnet 5 --- CODE_OF_CONDUCT.md | 7 ------- CONTRIBUTING.md | 9 +-------- README.md | 17 ++++++++--------- README.zh-CN.md | 23 +++++++++-------------- SECURITY.md | 8 -------- 5 files changed, 18 insertions(+), 46 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index dc87ca6..74debd3 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,12 +1,5 @@ # Code of Conduct -## 中文摘要 - -- 用途:本文档说明 QuantStrategyLab 仓库中的讨论、issue、pull request 和 review 行为规范。 -- 主要覆盖:`Our Standards`、`Project Scope`、`Reporting and Enforcement`。 -- 阅读顺序:参与讨论或提交 PR 前先确认沟通边界;发现不当行为时联系维护者。 -- 风险提示:涉及投资、交易、密钥或实盘系统的讨论必须保持克制、可复现和证据导向。 - ## Our Standards - Be respectful, direct, and evidence-oriented in issues, pull requests, reviews, and discussions. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1c6035b..27a54fc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,13 +1,5 @@ # Contributing -## 中文摘要 - -- 用途:本文档说明如何向 `QuantStrategyPlugins` 提交低风险、可审阅的变更。 -- 主要覆盖:`Ground Rules`、`Documentation Standards`、`Branching and Pull Requests`、`Local Verification`。 -- 阅读顺序:先确认仓库边界和变更范围,再运行适合本仓库的本地校验。 -- 风险提示:涉及策略、artifact、自动化、密钥、云资源、券商或交易所行为的变更,必须先用测试环境、dry-run 或只读证据验证;不要只凭示例修改生产。 -- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。 - Thanks for contributing to `QuantStrategyPlugins`. ## Ground Rules @@ -16,6 +8,7 @@ Thanks for contributing to `QuantStrategyPlugins`. - Keep refactors separate from behavior, contract, workflow, or documentation changes. - Preserve this repository's boundary as a sidecar strategy plugin package; do not move broker execution, live-allocation decisions, private credentials, or unrelated platform logic into it. - Add or update tests, examples, docs, or reproducible evidence when changing behavior or public contracts. +- Verify changes that touch strategy, artifact, automation, credential, cloud-resource, broker, or exchange behavior against a test environment, a dry run, or read-only evidence before they reach production; do not rely on an example alone. ## Documentation Standards diff --git a/README.md b/README.md index 2011fc0..82b6dd6 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,5 @@ # QuantStrategyPlugins - -## QSL architecture role - -- **Layer**: `strategy-lib`. -- **Responsibility**: sidecar strategy plugin package. -- **Owns**: plugin contracts, market-regime controls, notification/research plugin outputs. -- **Consumes**: QuantPlatformKit and strategy/pipeline consumers. -- **Must not**: decide live eligibility or connect to brokers directly. - [Chinese README](README.zh-CN.md) > Investing involves risk. This project does not provide investment advice and is for education, research, and engineering review only. @@ -19,6 +10,14 @@ QuantStrategyPlugins is a QuantStrategyLab strategy plugin package. It provides It supports the system but does not decide which strategy should be live. Strategy eligibility remains in the strategy and snapshot repositories; broker execution remains in the platform repositories. +## QSL architecture role + +- **Layer**: `strategy-lib`. +- **Responsibility**: sidecar strategy plugin package. +- **Owns**: plugin contracts, market-regime controls, notification/research plugin outputs. +- **Consumes**: QuantPlatformKit and strategy/pipeline consumers. +- **Must not**: decide live eligibility or connect to brokers directly. + ## Design boundary - Keep contracts stable and versioned where downstream repositories depend on them. diff --git a/README.zh-CN.md b/README.zh-CN.md index ac4ce47..eb8848d 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -1,14 +1,5 @@ # QuantStrategyPlugins - -## QSL 架构角色 - -- **层级**:`策略库`。 -- **职责**:sidecar 策略插件包。 -- **事实源/归属**:plugin contracts、market-regime controls、notification/research plugin outputs。 -- **消费对象**:QuantPlatformKit 和 strategy/pipeline consumers。 -- **禁止事项**:决定 live eligibility 或直接连接券商。 - [English README](README.md) > 投资有风险。本项目不构成投资建议,仅用于学习、研究和工程审阅。 @@ -19,6 +10,14 @@ QuantStrategyPlugins 是 QuantStrategyLab 的策略插件包。提供 market-reg 它支撑系统运行,但不决定哪个策略应该 live。策略资格由策略仓和 snapshot 仓负责;券商执行由平台仓负责。 +## QSL 架构角色 + +- **层级**:`策略库`。 +- **职责**:sidecar 策略插件包。 +- **事实源/归属**:plugin contracts、market-regime controls、notification/research plugin outputs。 +- **消费对象**:QuantPlatformKit 和 strategy/pipeline consumers。 +- **禁止事项**:决定 live eligibility 或直接连接券商。 + ## 设计边界 - 下游仓库依赖的契约要保持稳定,必要时做版本化。 @@ -26,11 +25,6 @@ QuantStrategyPlugins 是 QuantStrategyLab 的策略插件包。提供 market-reg - 密钥和环境专属配置不要写进共享库代码。 - 会影响多个平台或策略包的改动,需要在文档中说明。 -## 延伸文档 - -- [`docs/plugin_lifecycle_policy.zh-CN.md`](docs/plugin_lifecycle_policy.zh-CN.md) -- [`docs/strategy-plugin-signal-envelope-v2.zh-CN.md`](docs/strategy-plugin-signal-envelope-v2.zh-CN.md):纯本地、仅设计的确定性信号 envelope;未接入 runtime。 - ## 仓库结构 - `src/`:库代码和运行时代码。 @@ -51,6 +45,7 @@ python -m pytest -q - [`docs/plugin_lifecycle_policy.zh-CN.md`](docs/plugin_lifecycle_policy.zh-CN.md) - [`docs/market-regime-control-plan.md`](docs/market-regime-control-plan.md) - [`docs/market-regime-control-plan.zh-CN.md`](docs/market-regime-control-plan.zh-CN.md) +- [`docs/strategy-plugin-signal-envelope-v2.zh-CN.md`](docs/strategy-plugin-signal-envelope-v2.zh-CN.md):纯本地、仅设计的确定性信号 envelope;未接入 runtime。 ## 社区和安全 diff --git a/SECURITY.md b/SECURITY.md index f147253..a95a14b 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,13 +1,5 @@ # Security Policy -## 中文摘要 - -- 用途:本文档说明如何报告 `QuantStrategyPlugins` 的安全问题,以及密钥或凭证暴露时的处理顺序。 -- 主要覆盖:`Reporting a Vulnerability`、`Secret and Credential Exposure`、`Scope Notes`。 -- 阅读顺序:发现问题后先避免公开泄露,再通过私密渠道提供最小复现信息。 -- 风险提示:涉及实盘、密钥、权限、Cloud Run、GitHub Actions、交易所或券商 API 的问题,不要开公开 issue 或贴出敏感日志。 -- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。 - Thanks for helping keep `QuantStrategyPlugins` safe. This repository is part of the QuantStrategyLab automation, research, or trading-support surface. Please do **not** open a public issue for vulnerabilities involving credentials, broker or exchange access, cloud resources, workflow tokens, private market data, account identifiers, order execution, or secret material.