Skip to content

Commit e294c42

Browse files
committed
docs: add roadmap, consolidate good-first-issues
Moved most good-first-issues to a Roadmap section in README to keep the issue tracker focused. 3 well-scoped issues remain open for external contributors.
1 parent 3efd7ff commit e294c42

1 file changed

Lines changed: 23 additions & 11 deletions

File tree

README.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
<a href="#-api-server">API</a> &nbsp;&middot;&nbsp;
3535
<a href="#-mcp-plugin">MCP</a> &nbsp;&middot;&nbsp;
3636
<a href="#-project-structure">Structure</a> &nbsp;&middot;&nbsp;
37+
<a href="#-roadmap">Roadmap</a> &nbsp;&middot;&nbsp;
3738
<a href="#-contributing">Contributing</a>
3839
</p>
3940

@@ -569,22 +570,33 @@ Vibe-Trading is part of the **[HKUDS](https://github.com/HKUDS)** agent ecosyste
569570

570571
---
571572

573+
## 🗺 Roadmap
574+
575+
> We ship in phases. Items move to [Issues](https://github.com/HKUDS/Vibe-Trading/issues) when work begins.
576+
577+
| Phase | Feature | Status |
578+
|-------|---------|--------|
579+
| **Analysis & Viz** | Options volatility surface & Greeks 3D visualization | Planned |
580+
| | Cross-asset correlation heatmap with rolling window & clustering | Planned |
581+
| | Benchmark comparison in CLI backtest output | Planned |
582+
| | Calmar Ratio & Omega Ratio in backtest metrics | Planned |
583+
| **Skills & Presets** | Dividend Analysis skill | Planned |
584+
| | ESG / Sustainable Investing swarm preset | Planned |
585+
| | Emerging Markets Research Desk swarm preset | Planned |
586+
| **Portfolio & Optimization** | Advanced portfolio optimizer: leverage, sector caps, turnover constraints | Planned |
587+
| **Future** | Beginner tutorial: "5-minute natural language backtest" | Planned |
588+
| | Live data streaming via WebSocket | Exploring |
589+
| | Strategy marketplace (share & discover) | Exploring |
590+
591+
---
592+
572593
## Contributing
573594

574595
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
575596

576-
**Good first issues** are tagged with [`good first issue`](https://github.com/HKUDS/Vibe-Trading/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) — great for getting started.
577-
578-
Areas we'd love help with:
597+
**Good first issues** are tagged with [`good first issue`](https://github.com/HKUDS/Vibe-Trading/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) — pick one and get started.
579598

580-
| Area | Difficulty | Description |
581-
|------|:----------:|-------------|
582-
| Options vol surface & Greeks viz | Hard | 3D implied-vol surface, delta/gamma/vega charts in frontend |
583-
| Portfolio optimizer constraints | Medium | Leverage limits, sector caps, turnover penalties |
584-
| Correlation heatmap dashboard | Medium | Cross-asset correlation matrix with time-window slider |
585-
| New data source loader | Medium | Implement `DataLoader` Protocol for a new exchange/vendor |
586-
| New finance skill | Easy | Add a `SKILL.md` — e.g., pairs trading, mean reversion, VWAP |
587-
| New swarm preset | Easy | YAML config for a new multi-agent workflow |
599+
Want to contribute something bigger? Check the [Roadmap](#-roadmap) above and open an issue to discuss before starting.
588600

589601
---
590602

0 commit comments

Comments
 (0)