diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index dc87ca6..984bdb8 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. @@ -16,7 +9,7 @@ ## Project Scope -QuantStrategyLab repositories involve research, automation, strategy artifacts, and trading-support systems. Contributions should keep financial claims conservative and verifiable, separate research evidence from live-trading decisions, and avoid presenting examples as investment advice. +QuantStrategyLab repositories involve research, automation, strategy artifacts, and trading-support systems. Contributions should keep financial claims conservative and verifiable, separate research evidence from live-trading decisions, and avoid presenting examples as investment advice. Discussions touching strategy promotion, live-enablement evidence, or other live systems should stay measured, reproducible, and evidence-based rather than speculative. ## Reporting and Enforcement diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c96bfdf..11c880e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,13 +1,5 @@ # Contributing -## 中文摘要 - -- 用途：本文档说明如何向 `HkEquityStrategies` 提交低风险、可审阅的变更。 -- 主要覆盖：`Ground Rules`、`Documentation Standards`、`Branching and Pull Requests`、`Local Verification`。 -- 阅读顺序：先确认仓库边界和变更范围，再运行适合本仓库的本地校验。 -- 风险提示：涉及策略、artifact、自动化、密钥、云资源、券商或交易所行为的变更，必须先用测试环境、dry-run 或只读证据验证；不要只凭示例修改生产。 -- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。 - Thanks for contributing to `HkEquityStrategies`. ## Ground Rules @@ -16,6 +8,7 @@ Thanks for contributing to `HkEquityStrategies`. - Keep refactors separate from behavior, contract, workflow, or documentation changes. - Preserve this repository's boundary as a Hong Kong equity strategy 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. +- Changes touching strategy promotion, live-enablement evidence, or the runtime profile catalog must be verified against the documented evidence gates and readiness commands first; do not promote a profile or edit production catalogs based on the examples alone. ## Documentation Standards diff --git a/README.md b/README.md index df84f0d..8fa94aa 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,5 @@ # HkEquityStrategies - -## QSL architecture role - -- **Layer**: `strategy-library`. -- **Responsibility**: Hong Kong equity strategy implementation package. -- **Owns**: HK strategy code, manifests, runtime adapters, live-readiness checks. -- **Consumes**: QuantPlatformKit and validated HK snapshot artifacts. -- **Must not**: own broker credentials or deployment switches. - [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 @@ This repository is a strategy layer, not a broker or deployment layer. It does not store broker credentials, submit orders by itself, publish snapshot artifacts, or decide whether a profile is safe for live trading without external evidence. +## QSL architecture role + +- **Layer**: `strategy-library`. +- **Responsibility**: Hong Kong equity strategy implementation package. +- **Owns**: HK strategy code, manifests, runtime adapters, live-readiness checks. +- **Consumes**: QuantPlatformKit and validated HK snapshot artifacts. +- **Must not**: own broker credentials or deployment switches. + ## Current runtime surface Canonical profile names were simplified in this branch. The old names are not kept as aliases, so platform repositories should reference the canonical names below through `STRATEGY_PROFILE` or `RUNTIME_TARGET_JSON`. diff --git a/README.zh-CN.md b/README.zh-CN.md index 9ed3a57..a30d598 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -1,14 +1,5 @@ # HkEquityStrategies - -## QSL 架构角色 - -- **层级**：`策略库`。 -- **职责**：港股策略实现包。 -- **事实源/归属**：HK 策略代码、manifests、runtime adapters、live-readiness checks。 -- **消费对象**：QuantPlatformKit 和已验证 HK snapshot artifacts。 -- **禁止事项**：持有券商凭据或部署开关。 - [English README](README.md) > 投资有风险。本项目不构成投资建议，仅用于学习、研究和工程审阅。 @@ -19,6 +10,14 @@ 这是策略层，不是券商或部署层。本仓库不保存券商凭据，不自行下单，不发布 snapshot artifact，也不能在缺少外部证据的情况下决定某个 profile 是否适合 live。 +## QSL 架构角色 + +- **层级**：`策略库`。 +- **职责**：港股策略实现包。 +- **事实源/归属**：HK 策略代码、manifests、runtime adapters、live-readiness checks。 +- **消费对象**：QuantPlatformKit 和已验证 HK snapshot artifacts。 +- **禁止事项**：持有券商凭据或部署开关。 + ## 当前 runtime 面 本分支精简了 canonical profile 名。旧名称不再保留为 alias，因此平台仓库应通过 `STRATEGY_PROFILE` 或 `RUNTIME_TARGET_JSON` 使用下面的新名字。 diff --git a/SECURITY.md b/SECURITY.md index ff03bf3..9c408ad 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,13 +1,5 @@ # Security Policy -## 中文摘要 - -- 用途：本文档说明如何报告 `HkEquityStrategies` 的安全问题，以及密钥或凭证暴露时的处理顺序。 -- 主要覆盖：`Reporting a Vulnerability`、`Secret and Credential Exposure`、`Scope Notes`。 -- 阅读顺序：发现问题后先避免公开泄露，再通过私密渠道提供最小复现信息。 -- 风险提示：涉及实盘、密钥、权限、Cloud Run、GitHub Actions、交易所或券商 API 的问题，不要开公开 issue 或贴出敏感日志。 -- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。 - Thanks for helping keep `HkEquityStrategies` 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.