From 43e8ddc1216810a762e6a1d1afcea1cb132dc124 Mon Sep 17 00:00:00 2001
From: Pigbibi <20649888+Pigbibi@users.noreply.github.com>
Date: Wed, 7 Oct 2026 01:10:33 +0800
Subject: [PATCH] docs: rewrite governance templates into human-readable prose
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

README.md/README.zh-CN.md now open with a plain-language introduction
instead of a raw "QSL architecture role" field list (moved mid-document).
CONTRIBUTING.md, SECURITY.md, and CODE_OF_CONDUCT.md drop the repeated
"## 中文摘要" metadata block; the one piece of unique guidance in
CONTRIBUTING.md's summary (verify live-trading/credential/Cloud Run
changes in a test environment first) is folded into Ground Rules.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
---
 CODE_OF_CONDUCT.md |  7 -------
 CONTRIBUTING.md    |  9 +--------
 README.md          | 17 +++++++++--------
 README.zh-CN.md    | 17 +++++++++--------
 SECURITY.md        |  8 --------
 5 files changed, 19 insertions(+), 39 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 747f74c..020c3d2 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,13 +1,5 @@
 # Contributing
 
-
-## 中文摘要
-
-- 用途：本文档围绕 `Contributing`，用于理解 `CryptoLivePoolPipelines` 的配置、运行、部署、研究或验收边界。
-- 主要覆盖：`Ground Rules`、`Branching and Pull Requests`、`Local Verification`。
-- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。
-- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。
-- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。
 Thanks for contributing to `CryptoLivePoolPipelines`.
 
 ## Ground Rules
@@ -16,6 +8,7 @@ Thanks for contributing to `CryptoLivePoolPipelines`.
 - Keep refactors separate from behavior changes.
 - Add or update tests when changing runtime behavior.
 - Do not use deployment or scheduled workflows as a substitute for local verification.
+- Changes that touch live trading, credentials, permissions, Cloud Run, or exchange/broker APIs must be verified in a test environment or dry run first; do not edit production based on examples alone.
 
 ## Branching and Pull Requests
 
diff --git a/README.md b/README.md
index 0408b9d..beb180b 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,6 @@
 # CryptoLivePoolPipelines
 
-
-## QSL architecture role
-
-- **Layer**: `pipeline`.
-- **Responsibility**: crypto live-pool and release pipeline.
-- **Owns**: monthly live-pool membership, ordering, validation artifacts.
-- **Consumes**: market data inputs, QuantPlatformKit helpers.
-- **Must not**: place trades or bypass downstream artifact contract checks.
+CryptoLivePoolPipelines selects and publishes the monthly crypto live-pool used by QuantStrategyLab's crypto strategies. It ranks candidate symbols, decides which ones stay in the published pool and in what order, and produces the validation artifacts that downstream strategy code reads before trading on them. It does not place trades itself; it is the upstream evidence and release pipeline that other repositories depend on.
 
 [Chinese README](README.zh-CN.md)
 
@@ -39,6 +32,14 @@ CryptoStrategies and BinancePlatform should consume only release artifacts that
 
 Live-pool artifacts are used to make strategy decisions reproducible: ranking inputs, live-pool snapshots, manifests, validation summaries, and promotion evidence. `live_pool.json` and `artifact_manifest.json` are the stable downstream execution contract; ranking files and research outputs stay upstream evidence unless the contract explicitly promotes them. They are not marketing claims. Before a downstream repository promotes a profile, review the latest artifacts across short, medium, and long windows where applicable.
 
+## QSL architecture role
+
+- **Layer**: `pipeline`.
+- **Responsibility**: crypto live-pool and release pipeline.
+- **Owns**: monthly live-pool membership, ordering, validation artifacts.
+- **Consumes**: market data inputs, QuantPlatformKit helpers.
+- **Must not**: place trades or bypass downstream artifact contract checks.
+
 ## Repository layout
 
 - `src/`: library and runtime code.
diff --git a/README.zh-CN.md b/README.zh-CN.md
index f679c6b..95b8320 100644
--- a/README.zh-CN.md
+++ b/README.zh-CN.md
@@ -1,13 +1,6 @@
 # CryptoLivePoolPipelines
 
-
-## QSL 架构角色
-
-- **层级**：`快照/证据流水线`。
-- **职责**：加密 live-pool 与发布流水线。
-- **事实源/归属**：月度 live-pool 成员、排序、验证 artifacts。
-- **消费对象**：市场数据输入、QuantPlatformKit helpers。
-- **禁止事项**：下单或绕过下游 artifact contract 检查。
+CryptoLivePoolPipelines 负责挑选并发布 QuantStrategyLab 加密策略所用的月度 live-pool。它对候选币种排序，决定哪些币种留在已发布的池子里、顺序如何排列，并产出下游策略代码在下单前要读取的验证产物。它本身不下单，是其它仓库依赖的上游证据与发布流水线。
 
 [English README](README.md)
 
@@ -39,6 +32,14 @@ CryptoStrategies 和 BinancePlatform 应只消费通过 contract 检查的发布
 
 Live-pool artifact 的作用是让策略判断可复现：包括 ranking 输入、live-pool snapshot、manifest、validation summary 和提升证据。`live_pool.json` 和 `artifact_manifest.json` 是稳定的下游执行合约；ranking 文件和研究输出默认留在上游作为证据，除非合约明确提升它们。它们不是宣传式收益承诺。下游仓库提升 profile 前，应在适用场景下检查最新短、中、长周期产物。
 
+## QSL 架构角色
+
+- **层级**：`快照/证据流水线`。
+- **职责**：加密 live-pool 与发布流水线。
+- **事实源/归属**：月度 live-pool 成员、排序、验证 artifacts。
+- **消费对象**：市场数据输入、QuantPlatformKit helpers。
+- **禁止事项**：下单或绕过下游 artifact contract 检查。
+
 ## 月度 review 自动化
 
 月度 publish workflow 通过 `AIAuditBridge` 触发自动 review 和 remediation；`CODEX_AUDIT_PROVIDER` 默认走 `auto`，优先调用 AIAuditBridge 的 HTTPS/443 service-backed Codex 路径，再按桥接仓库配置 fallback 到 API reviewer。`OPENAI_API_KEY` 和 `ANTHROPIC_API_KEY` 等 provider secret 配置在 `AIAuditBridge`，本仓库不直接读取这些 provider key。可通过 `CODEX_AUDIT_BRIDGE_REF` pin 到指定 bridge ref，默认 `main`。
diff --git a/SECURITY.md b/SECURITY.md
index 1120518..8338d5a 100644
--- a/SECURITY.md
+++ b/SECURITY.md
@@ -1,13 +1,5 @@
 # Security Policy
 
-
-## 中文摘要
-
-- 用途：本文档围绕 `Security Policy`，用于理解 `CryptoLivePoolPipelines` 的配置、运行、部署、研究或验收边界。
-- 主要覆盖：`Reporting a Vulnerability`、`Secret and Credential Exposure`、`Scope Notes`。
-- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。
-- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。
-- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。
 Thanks for helping keep `CryptoLivePoolPipelines` safe.
 
 This repository is part of a research and release pipeline. Please do **not** open a public issue for vulnerabilities involving credentials, broker access, cloud resources, order execution, or secret material.