From 365ce3e2a3198731f5251289d703b7ec72b09b44 Mon Sep 17 00:00:00 2001 From: Pigbibi <20649888+Pigbibi@users.noreply.github.com> Date: Wed, 3 Jun 2026 17:58:10 +0800 Subject: [PATCH] docs: rewrite open-source readmes --- README.md | 51 ++++++++++++++----------------------------------- README.zh-CN.md | 51 ++++++++++++++----------------------------------- 2 files changed, 28 insertions(+), 74 deletions(-) diff --git a/README.md b/README.md index cca7e4e..7bd15a7 100644 --- a/README.md +++ b/README.md @@ -2,61 +2,38 @@ [Chinese README](README.zh-CN.md) -> ⚠️ Investing involves risk. This project does not provide investment advice and is for educational and research purposes only. +> Investing involves risk. This project does not provide investment advice and is for education, research, and engineering review only. -## What this project does +## What this repository is -QuantRuntimeSettings is a **Runtime configuration package** in the QuantStrategyLab ecosystem. It defines schemas and tooling for shared QuantStrategyLab runtime settings. +QuantRuntimeSettings is a QuantStrategyLab runtime settings package. It defines schemas and tooling for versioned runtime settings shared across QuantStrategyLab platforms. -## Who this is for +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. -- Engineers and researchers who want to inspect, reproduce, or extend this part of the QuantStrategyLab stack. -- Operators who need a clear entry point before reading the deeper runbooks or workflow files. -- Reviewers who need to understand the repository purpose, safety boundary, and evidence requirements before enabling automation. +## Design boundary -## Current status - -Shared configuration contract; changes can affect multiple platforms. +- Keep contracts stable and versioned where downstream repositories depend on them. +- Prefer backward-compatible changes unless a coordinated migration is planned. +- Keep secrets and environment-specific settings outside the shared library code. +- Document changes that affect multiple platforms or strategy packages. ## Repository layout -- `tests/`: unit and contract tests. -- `.github/workflows/`: CI, scheduled jobs, and deployment workflows. +- `tests/`: unit, contract, and regression tests. +- `.github/workflows/`: CI, scheduled jobs, release, or deployment workflows. - `scripts/`: operator scripts and local helpers. ## Quick start -From a fresh clone: - ```bash python -m pip install -e . python -m pytest -q ``` -If a command requires credentials, run it only after reading the relevant workflow or runbook and configuring secrets outside Git. - -## Deployment and operation - -Use the schemas in platform repositories and CI validation. Roll out setting changes through review, dry-run validation, and controlled platform deployment. - -Prefer manual or dry-run execution first. Enable schedules or live execution only after logs, artifacts, permissions, and rollback steps are reviewed. - -## Strategy performance and evidence - -Not a strategy repository. Quality is measured by compatibility, validation coverage, and reducing configuration mistakes. - -README files are intentionally not a source of dated performance promises. Re-run the relevant tests, backtests, or pipeline jobs before relying on any result. - -## Safety notes - -- Never commit API keys, broker credentials, OAuth tokens, cookies, or account identifiers. -- Run new strategies and platform changes in dry-run or paper mode before any live execution. -- Review generated orders, artifacts, and logs manually before enabling schedules. - -## Contributing +## Useful docs -Keep changes small, reproducible, and covered by the narrowest useful tests. For strategy-facing changes, include the evidence artifact or command used to validate behavior. +- No separate `docs/` directory yet; start with this README and the workflow files. ## License -See [LICENSE](LICENSE) if present in this repository. +See [LICENSE](LICENSE). diff --git a/README.zh-CN.md b/README.zh-CN.md index b5a17e9..b9c2477 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -2,61 +2,38 @@ [English README](README.md) -> ⚠️ 投资有风险，不构成投资建议，仅供学习交流用途。 +> 投资有风险。本项目不构成投资建议，仅用于学习、研究和工程审阅。 -## 这个项目做什么 +## 这个仓库是什么 -QuantRuntimeSettings 是 QuantStrategyLab 体系中的**运行配置包**。定义 QuantStrategyLab 共享运行配置的 schema 和工具。 +QuantRuntimeSettings 是 QuantStrategyLab 的运行配置包。为 QuantStrategyLab 平台提供版本化运行配置 schema 和工具。 -## 适合谁使用 +它支撑系统运行，但不决定哪个策略应该 live。策略资格由策略仓和 snapshot 仓负责；券商执行由平台仓负责。 -- 希望阅读、复现或扩展 QuantStrategyLab 相关模块的工程师和研究人员。 -- 在阅读详细 runbook 或 workflow 前，需要先理解项目入口的运维人员。 -- 在启用自动化前，需要确认项目职责、安全边界和证据要求的 reviewer。 +## 设计边界 -## 当前状态 - -共享配置契约；改动可能影响多个执行平台。 +- 下游仓库依赖的契约要保持稳定，必要时做版本化。 +- 除非有协同迁移计划，否则优先保持向后兼容。 +- 密钥和环境专属配置不要写进共享库代码。 +- 会影响多个平台或策略包的改动，需要在文档中说明。 ## 仓库结构 -- `tests/`：单元测试和契约测试。 -- `.github/workflows/`：CI、定时任务和部署 workflow。 +- `tests/`：单元测试、契约测试和回归测试。 +- `.github/workflows/`：CI、定时任务、发布或部署 workflow。 - `scripts/`：运维脚本和本地辅助工具。 ## 快速开始 -从全新 clone 开始： - ```bash python -m pip install -e . python -m pytest -q ``` -如果命令需要凭据，请先阅读相关 workflow 或 runbook，并把密钥配置在 Git 之外。 - -## 部署和运行 - -在平台仓库和 CI 校验中使用这些 schema。配置变更应经过 review、dry-run 验证和受控平台发布。 - -建议先手工运行或 dry-run。只有在日志、产物、权限和回滚步骤都检查过之后，才启用定时任务或 live 执行。 - -## 策略表现与证据边界 - -这不是策略仓库。质量标准是兼容性、校验覆盖和减少配置错误。 - -README 不应该承诺固定收益或过期指标。实际使用前，请重新运行对应测试、回测或流水线任务。 - -## 安全注意事项 - -- 不要把 API key、券商凭据、OAuth token、Cookie 或账户标识提交到 Git。 -- 新策略或平台变更在 live 前必须先跑 dry-run 或 paper 流程。 -- 启用定时任务前，需要人工检查生成的订单、产物和日志。 - -## 参与贡献 +## 延伸文档 -请保持改动小、可复现，并用最小必要测试覆盖。涉及策略的改动，需要附上验证行为的证据产物或命令。 +- 暂无独立 `docs/` 目录；请先阅读本 README 和 workflow 文件。 ## 许可证 -如仓库包含 [LICENSE](LICENSE)，请以该文件为准。 +详见 [LICENSE](LICENSE)。