From 406455d552c2b49f5b26971601ab1d74895a6503 Mon Sep 17 00:00:00 2001 From: Pigbibi <20649888+Pigbibi@users.noreply.github.com> Date: Wed, 7 Oct 2026 01:56:16 +0800 Subject: [PATCH] docs: move architecture role below intro, drop templated summary blocks MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit README/README.zh-CN: move the "QSL architecture role" field list below the human-readable "What this repository is" intro instead of leading with it. CONTRIBUTING/SECURITY/CODE_OF_CONDUCT: remove the boilerplate "中文摘要" meta-description block duplicated verbatim across sibling repos; the one substantive risk note not already covered in English prose was folded into CONTRIBUTING's Ground Rules instead of dropped. Co-Authored-By: Claude Sonnet 5 --- CODE_OF_CONDUCT.md | 7 ------- CONTRIBUTING.md | 9 +-------- README.md | 17 ++++++++--------- README.zh-CN.md | 17 ++++++++--------- SECURITY.md | 8 -------- 5 files changed, 17 insertions(+), 41 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 f0efb57..4e5ac2a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,13 +1,5 @@ # Contributing -## 中文摘要 - -- 用途:本文档说明如何向 `ResearchSignalContextPipelines` 提交低风险、可审阅的变更。 -- 主要覆盖:`Ground Rules`、`Documentation Standards`、`Branching and Pull Requests`、`Local Verification`。 -- 阅读顺序:先确认仓库边界和变更范围,再运行适合本仓库的本地校验。 -- 风险提示:涉及策略、artifact、自动化、密钥、云资源、券商或交易所行为的变更,必须先用测试环境、dry-run 或只读证据验证;不要只凭示例修改生产。 -- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。 - Thanks for contributing to `ResearchSignalContextPipelines`. ## Ground Rules @@ -15,6 +7,7 @@ Thanks for contributing to `ResearchSignalContextPipelines`. - Prefer small pull requests with one clear purpose. - Keep refactors separate from behavior, contract, workflow, or documentation changes. - Preserve this repository's boundary as a research signal context pipeline; do not move broker execution, live-allocation decisions, private credentials, or unrelated platform logic into it. +- Verify changes to strategy inputs, artifacts, automation, credentials, or cloud resources with a test environment, dry run, or read-only evidence before they can affect production; do not rely on examples alone. - Add or update tests, examples, docs, or reproducible evidence when changing behavior or public contracts. ## Documentation Standards diff --git a/README.md b/README.md index 82c5c53..4fc26c7 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,5 @@ # ResearchSignalContextPipelines - -## QSL architecture role - -- **Layer**: `research`. -- **Responsibility**: medium/long-horizon research signal context pipeline. -- **Owns**: theme context artifacts and AI shadow context outputs. -- **Consumes**: public/research inputs and downstream advisory/pipeline consumers. -- **Must not**: submit orders or mutate live runtime allocations. - [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 @@ ResearchSignalContextPipelines is a QuantStrategyLab research signal context pip It produces research, audit, or orchestration artifacts. It should not submit broker orders or mutate live allocations by itself. +## QSL architecture role + +- **Layer**: `research`. +- **Responsibility**: medium/long-horizon research signal context pipeline. +- **Owns**: theme context artifacts and AI shadow context outputs. +- **Consumes**: public/research inputs and downstream advisory/pipeline consumers. +- **Must not**: submit orders or mutate live runtime allocations. + ## Output boundary - Treat generated reports as evidence or review material, not automatic trading instructions. diff --git a/README.zh-CN.md b/README.zh-CN.md index fc62c1b..8be8e86 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -1,14 +1,5 @@ # ResearchSignalContextPipelines - -## QSL 架构角色 - -- **层级**:`研究/证据`。 -- **职责**:中长期 research signal context 流水线。 -- **事实源/归属**:theme context artifacts 和 AI shadow context outputs。 -- **消费对象**:公开/研究输入和下游 advisory/pipeline consumers。 -- **禁止事项**:下单或修改 live runtime allocations。 - [English README](README.md) > 投资有风险。本项目不构成投资建议,仅用于学习、研究和工程审阅。 @@ -19,6 +10,14 @@ ResearchSignalContextPipelines 是 QuantStrategyLab 的研究信号上下文流 它产出研究、审计或编排类 artifact,不应自行提交券商订单,也不应直接修改 live allocation。 +## QSL 架构角色 + +- **层级**:`研究/证据`。 +- **职责**:中长期 research signal context 流水线。 +- **事实源/归属**:theme context artifacts 和 AI shadow context outputs。 +- **消费对象**:公开/研究输入和下游 advisory/pipeline consumers。 +- **禁止事项**:下单或修改 live runtime allocations。 + ## 输出边界 - 生成报告应作为证据或审阅材料,不是自动交易指令。 diff --git a/SECURITY.md b/SECURITY.md index a5dfcd4..70060eb 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,13 +1,5 @@ # Security Policy -## 中文摘要 - -- 用途:本文档说明如何报告 `ResearchSignalContextPipelines` 的安全问题,以及密钥或凭证暴露时的处理顺序。 -- 主要覆盖:`Reporting a Vulnerability`、`Secret and Credential Exposure`、`Scope Notes`。 -- 阅读顺序:发现问题后先避免公开泄露,再通过私密渠道提供最小复现信息。 -- 风险提示:涉及实盘、密钥、权限、Cloud Run、GitHub Actions、交易所或券商 API 的问题,不要开公开 issue 或贴出敏感日志。 -- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。 - Thanks for helping keep `ResearchSignalContextPipelines` 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.