|
2 | 2 |
|
3 | 3 | [Chinese README](README.zh-CN.md) |
4 | 4 |
|
5 | | -> ⚠️ Investing involves risk. This project does not provide investment advice and is for educational and research purposes only. |
| 5 | +> Investing involves risk. This project does not provide investment advice and is for education, research, and engineering review only. |
6 | 6 |
|
7 | | -## What this project does |
| 7 | +## What this repository is |
8 | 8 |
|
9 | | -ResearchSignalContextPipelines is a **Research context pipeline** in the QuantStrategyLab ecosystem. It builds research signal context artifacts for medium-horizon themes and long-horizon AI shadow context. |
| 9 | +ResearchSignalContextPipelines is a QuantStrategyLab research signal context pipeline. It builds medium-horizon theme context and long-horizon AI shadow context artifacts. |
10 | 10 |
|
11 | | -## Who this is for |
| 11 | +It produces research, audit, or orchestration artifacts. It should not submit broker orders or mutate live allocations by itself. |
12 | 12 |
|
13 | | -- Engineers and researchers who want to inspect, reproduce, or extend this part of the QuantStrategyLab stack. |
14 | | -- Operators who need a clear entry point before reading the deeper runbooks or workflow files. |
15 | | -- Reviewers who need to understand the repository purpose, safety boundary, and evidence requirements before enabling automation. |
| 13 | +## Output boundary |
16 | 14 |
|
17 | | -## Current status |
18 | | - |
19 | | -Research-only artifact pipeline; outputs are context, not trade instructions. |
| 15 | +- Treat generated reports as evidence or review material, not automatic trading instructions. |
| 16 | +- Keep source traceability and artifact timestamps visible. |
| 17 | +- Require human review before using outputs in downstream strategy or platform changes. |
| 18 | +- Keep credentials, private data, and external service tokens out of Git and logs. |
20 | 19 |
|
21 | 20 | ## Repository layout |
22 | 21 |
|
23 | | -- `src/`: main library and runtime code. |
24 | | -- `tests/`: unit and contract tests. |
25 | | -- `docs/`: detailed design notes, runbooks, and evidence docs. |
26 | | -- `.github/workflows/`: CI, scheduled jobs, and deployment workflows. |
| 22 | +- `src/`: library and runtime code. |
| 23 | +- `tests/`: unit, contract, and regression tests. |
| 24 | +- `docs/`: runbooks, design notes, evidence, and integration contracts. |
| 25 | +- `.github/workflows/`: CI, scheduled jobs, release, or deployment workflows. |
27 | 26 | - `scripts/`: operator scripts and local helpers. |
| 27 | +- `config/`: runtime or pipeline configuration. |
28 | 28 |
|
29 | 29 | ## Quick start |
30 | 30 |
|
31 | | -From a fresh clone: |
32 | | - |
33 | 31 | ```bash |
34 | 32 | python -m pip install -e . |
35 | 33 | python -m pytest -q |
36 | 34 | ``` |
37 | 35 |
|
38 | | -If a command requires credentials, run it only after reading the relevant workflow or runbook and configuring secrets outside Git. |
39 | | - |
40 | | -## Deployment and operation |
41 | | - |
42 | | -Run the configured workflows or local commands to refresh artifacts. Review source coverage and artifact diffs before publishing downstream. |
43 | | - |
44 | | -Prefer manual or dry-run execution first. Enable schedules or live execution only after logs, artifacts, permissions, and rollback steps are reviewed. |
45 | | - |
46 | | -## Strategy performance and evidence |
47 | | - |
48 | | -Not a trading strategy repository. Evidence quality is measured by source traceability, freshness, and downstream review usefulness. |
49 | | - |
50 | | -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. |
51 | | - |
52 | | -## Safety notes |
53 | | - |
54 | | -- Never commit API keys, broker credentials, OAuth tokens, cookies, or account identifiers. |
55 | | -- Run new strategies and platform changes in dry-run or paper mode before any live execution. |
56 | | -- Review generated orders, artifacts, and logs manually before enabling schedules. |
57 | | - |
58 | | -## Contributing |
| 36 | +## Useful docs |
59 | 37 |
|
60 | | -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. |
| 38 | +- [`docs/architecture.md`](docs/architecture.md) |
61 | 39 |
|
62 | 40 | ## License |
63 | 41 |
|
64 | | -See [LICENSE](LICENSE) if present in this repository. |
| 42 | +See [LICENSE](LICENSE). |
0 commit comments