Skip to content

docs: human-readable README ordering and governance file cleanup #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Pigbibi merged 1 commit into from
Oct 6, 2026
Merged

docs: human-readable README ordering and governance file cleanup #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
View file
Open in desktop
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
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@
# Contributing

## 中文摘要

- 用途：本文档说明如何向 `QuantAdvisorResearch` 提交低风险、可审阅的变更。
- 主要覆盖：`Ground Rules`、`Documentation Standards`、`Branching and Pull Requests`、`Local Verification`。
- 阅读顺序：先确认仓库边界和变更范围，再运行适合本仓库的本地校验。
- 风险提示：涉及策略、artifact、自动化、密钥、云资源、券商或交易所行为的变更，必须先用测试环境、dry-run 或只读证据验证；不要只凭示例修改生产。
- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。

Thanks for contributing to `QuantAdvisorResearch`.

## Ground Rules
Expand All @@ -16,6 +8,7 @@ Thanks for contributing to `QuantAdvisorResearch`.
- Keep refactors separate from behavior, contract, workflow, or documentation changes.
- Preserve this repository's boundary as a research publishing system; 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.
- Validate changes that touch automation, credentials, cloud resources, or broker/exchange-facing behavior with tests, dry-run, or read-only evidence before they reach production; do not rely on a worked example alone.

## Documentation Standards

Expand Down
17 changes: 8 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,5 @@
# QuantAdvisorResearch


## QSL architecture role

- **Layer**: `research`.
- **Responsibility**: research-oriented advisory publishing system.
- **Owns**: traceable advisory reports and web/RSS evidence summaries.
- **Consumes**: public web/RSS inputs and research signal context.
- **Must not**: submit orders, allocation changes, or account advice automatically.

[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 @@ QuantAdvisorResearch is a QuantStrategyLab research publishing system. It publis

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**: research-oriented advisory publishing system.
- **Owns**: traceable advisory reports and web/RSS evidence summaries.
- **Consumes**: public web/RSS inputs and research signal context.
- **Must not**: submit orders, allocation changes, or account advice automatically.

## Output boundary

- Treat generated reports as evidence or review material, not automatic trading instructions.
Expand Down
17 changes: 8 additions & 9 deletions README.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,5 @@
# QuantAdvisorResearch


## QSL 架构角色

- **层级**：`研究/证据`。
- **职责**：研究型 advisory 发布系统。
- **事实源/归属**：可追溯 advisory reports 和 web/RSS 证据摘要。
- **消费对象**：公开 web/RSS 输入和 research signal context。
- **禁止事项**：自动提交订单、allocation changes 或账户建议。

[English README](README.md)

> 投资有风险。本项目不构成投资建议，仅用于学习、研究和工程审阅。
Expand All @@ -19,6 +10,14 @@ QuantAdvisorResearch 是 QuantStrategyLab 的研究发布系统。基于网页

它产出研究、审计或编排类 artifact，不应自行提交券商订单，也不应直接修改 live allocation。

## QSL 架构角色

- **层级**：`研究/证据`。
- **职责**：研究型 advisory 发布系统。
- **事实源/归属**：可追溯 advisory reports 和 web/RSS 证据摘要。
- **消费对象**：公开 web/RSS 输入和 research signal context。
- **禁止事项**：自动提交订单、allocation changes 或账户建议。

## 输出边界

- 生成报告应作为证据或审阅材料，不是自动交易指令。
Expand Down
8 changes: 0 additions & 8 deletions SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@
# Security Policy

## 中文摘要

- 用途：本文档说明如何报告 `QuantAdvisorResearch` 的安全问题，以及密钥或凭证暴露时的处理顺序。
- 主要覆盖：`Reporting a Vulnerability`、`Secret and Credential Exposure`、`Scope Notes`。
- 阅读顺序：发现问题后先避免公开泄露，再通过私密渠道提供最小复现信息。
- 风险提示：涉及实盘、密钥、权限、Cloud Run、GitHub Actions、交易所或券商 API 的问题，不要开公开 issue 或贴出敏感日志。
- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。

Thanks for helping keep `QuantAdvisorResearch` 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