Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
9 changes: 1 addition & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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

Expand Down
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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.
Expand Down
23 changes: 9 additions & 14 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -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)

> 投资有风险。本项目不构成投资建议,仅用于学习、研究和工程审阅。
Expand All @@ -19,18 +10,21 @@ QuantStrategyPlugins 是 QuantStrategyLab 的策略插件包。提供 market-reg

它支撑系统运行,但不决定哪个策略应该 live。策略资格由策略仓和 snapshot 仓负责;券商执行由平台仓负责。

## QSL 架构角色

- **层级**:`策略库`。
- **职责**:sidecar 策略插件包。
- **事实源/归属**:plugin contracts、market-regime controls、notification/research plugin outputs。
- **消费对象**:QuantPlatformKit 和 strategy/pipeline consumers。
- **禁止事项**:决定 live eligibility 或直接连接券商。

## 设计边界

- 下游仓库依赖的契约要保持稳定,必要时做版本化。
- 除非有协同迁移计划,否则优先保持向后兼容。
- 密钥和环境专属配置不要写进共享库代码。
- 会影响多个平台或策略包的改动,需要在文档中说明。

## 延伸文档

- [`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/`:库代码和运行时代码。
Expand All @@ -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。

## 社区和安全

Expand Down
8 changes: 0 additions & 8 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Loading