规范文件

2026-06-07 14:34:05 +08:00
parent c83cddbcc4
commit 4bf9461009
8 changed files with 2905 additions and 826 deletions
@@ -0,0 +1,182 @@
+---
+name: Bug 报告
+about: 创建一个 Bug 报告帮助我们改进
+title: "[Bug] "
+labels: bug
+assignees: []
+---
+
+## Bug 描述
+
+请简洁清晰地描述这个 Bug。
+
+## 复现步骤
+
+请提供最简化的复现步骤（代码片段或操作序列）：
+
+1. 
+2. 
+3. 
+4. 
+
+## 预期行为
+
+请描述您期望发生的结果。
+
+## 实际行为
+
+请描述实际发生的结果。包括完整的错误消息、panic 信息或日志输出。
+
+## 环境
+
+| 项目 | 版本 |
+|------|------|
+| Rust 版本 | `rustc --version` 输出 |
+| Crate 版本 | `chanlun` 版本号 |
+| 操作系统 | Linux / macOS / Windows |
+| 数据文件（.nb） | 文件路径或来源 |
+
+## 复现代码
+
+请粘贴可复现问题的最小 Rust 代码或 Python 代码。
+
+**Rust:**
+
+```rust
+use chanlun::config::缠论配置;
+use chanlun::kline::bar::K线;
+use chanlun::business::observer::观察者;
+
+// 复现代码
+```
+
+**Python (绑定层):**
+
+```python
+import chanlun
+
+# 复现代码
+```
+
+## 缠论配置
+
+请提供您使用的完整配置（JSON 或代码形式）。这对于复现问题至关重要。
+
+<details>
+<summary>展开查看配置 JSON</summary>
+
+```json
+{
+  "标识": "btcusd",
+  "缠K合并替换": false,
+  "笔内元素数量": 5,
+  "笔内相同终点取舍": false,
+  "笔内起始分型包含整笔": false,
+  "笔内起始分型包含整笔_包括右": false,
+  "笔内原始K线包含整笔": false,
+  "笔次级成笔": false,
+  "笔弱化": false,
+  "笔弱化_原始数量": 3,
+  "线段_非缺口下穿刺": false,
+  "线段_特征序列忽视老阴老阳": false,
+  "线段_缺口后紧急修正": true,
+  "线段_修正": false,
+  "线段内部中枢图显": true,
+  "扩展线段_当下分析": false,
+  "分析笔": true,
+  "分析线段": true,
+  "分析扩展线段": true,
+  "分析笔中枢": true,
+  "分析线段中枢": true,
+  "手动终止": "",
+  "计算指标": true,
+  "计算BOLL": false,
+  "指标计算方式": "收",
+  "平滑异同移动平均线_快线周期": 13,
+  "平滑异同移动平均线_慢线周期": 31,
+  "平滑异同移动平均线_信号周期": 11,
+  "MACD_参数列表": [],
+  "相对强弱指数_周期": 13,
+  "相对强弱指数_移动平均线周期": 13,
+  "相对强弱指数_超买阈值": 75.0,
+  "相对强弱指数_超卖阈值": 25.0,
+  "RSI_周期列表": [],
+  "随机指标_RSV周期": 13,
+  "随机指标_K值平滑周期": 5,
+  "随机指标_D值平滑周期": 5,
+  "随机指标_超买阈值": 80.0,
+  "随机指标_超卖阈值": 20.0,
+  "KDJ_参数列表": [],
+  "布林带_周期": 20,
+  "布林带_标准差倍数": 2.0,
+  "BOLL_参数列表": [],
+  "均线_类型列表": [],
+  "均线_周期列表": [],
+  "图表展示": true,
+  "推送K线": true,
+  "推送笔": true,
+  "推送线段": true,
+  "推送中枢": true,
+  "图表展示_笔": true,
+  "图表展示_线段": true,
+  "图表展示_扩展线段": true,
+  "图表展示_扩展线段_线段": true,
+  "图表展示_线段_线段": true,
+  "图表展示_中枢_笔": true,
+  "图表展示_中枢_线段": true,
+  "图表展示_中枢_扩展线段": true,
+  "图表展示_中枢_扩展线段_线段": true,
+  "图表展示_中枢_线段_线段": true,
+  "图表展示_中枢_线段内部": true,
+  "买卖点偏移": 1,
+  "买卖点激进识别": false,
+  "买卖点与MACD柱强相关": false,
+  "买卖点错过误差值": 0.01,
+  "买卖点_指标模式": "配置",
+  "买卖点_指标匹配_MACD": true,
+  "买卖点_指标匹配_KDJ": true,
+  "买卖点_指标匹配_RSI": true,
+  "买卖点_背离率": "Infinity",
+  "买卖点_T2_回调阈值": 1.0,
+  "买卖点_T2S_最大层级": 3,
+  "买卖点_峰值条件": false,
+  "买卖点_计算方式": "峰",
+  "买卖点_计算线段BSP1": true,
+  "买卖点_处理BSP2": true,
+  "买卖点_计算线段BSP3": true,
+  "买卖点_依赖T1": true,
+  "买卖点_中枢来源": "合",
+  "买卖点_调试输出": false,
+  "线段内部背驰_MACD": true,
+  "线段内部背驰_斜率": true,
+  "线段内部背驰_测度": true,
+  "线段内部背驰_模式": "相对",
+  "加载文件路径": ""
+}
+```
+
+</details>
+
+> **请修改上述 JSON 为您实际使用的配置值**，或直接粘贴通过 `config.to_json()` 输出的 JSON。
+
+## 上下文
+
+- [ ] 此 Bug 在 `chan.py` (Python 参考实现) 中也存在吗？
+  - Python 版行为：
+- [ ] 此 Bug 是否与特定数据文件相关？
+  - 数据文件名/时间范围：
+
+## 日志 / Panic 输出
+
+<details>
+<summary>展开查看详细输出</summary>
+
+```
+在此粘贴日志或 panic 输出
+```
+
+</details>
+
+## 补充信息
+
+任何其他有助于理解此 Bug 的上下文、截图或补充说明。
@@ -0,0 +1,36 @@
+---
+name: 自定义问题
+about: 其他问题（问题咨询、文档改进、重构建议等）
+title: "[Question] "
+labels: question
+assignees: []
+---
+
+## 问题概述
+
+请描述您的需求。
+
+## 问题类型
+
+- [ ] 问题咨询 — 对 API 或算法的使用存在疑问
+- [ ] 文档 — 文档错误、缺失或改进建议
+- [ ] 重构 — 代码结构或设计调整建议
+- [ ] 兼容性 — Python 绑定层与 `chan.py` 的行为差异
+- [ ] 性能 — 运行效率或内存占用问题
+- [ ] 其他
+
+## 涉及范围
+
+> 可选择一项或多项。
+
+| 层次 | 模块 |
+|------|------|
+| 核心层 | `types` / `kline` / `indicators` / `algorithm` / `structure` / `business` / `config` |
+| 绑定层 | `chanlun-py` (`src/business_py.rs` / `src/config_py.rs` / `src/structure_py.rs`) |
+| 测试 | `chanlun/src/*/tests` / `chanlun-py/tests/test_all.py` |
+| 文档 | `chanlun/README.md` / `CLAUDE.md` / 其他 |
+| 其他 | |
+
+## 补充信息
+
+任何有助于更好理解或解决此问题的信息。
@@ -0,0 +1,62 @@
+---
+name: 功能请求
+about: 提出一个新的功能或增强建议
+title: "[Feature] "
+labels: enhancement
+assignees: []
+---
+
+## 动机
+
+请描述这个功能要解决什么问题，或者满足什么使用场景。
+
+## 提案
+
+请描述您期望的功能或 API。
+
+**Rust 核心层:**
+
+```rust
+// 期望的 API 或行为
+```
+
+**Python 绑定层 (如适用):**
+
+```python
+# 期望的 API 或行为
+```
+
+## 替代方案
+
+是否有其他替代方案或现有机制可以满足需求？如果有，请描述。
+
+## 与 chan.py 的关系
+
+- [ ] `chan.py` (Python 参考实现) 中已有此功能
+  - 相关代码位置: `chan.py` 行号或方法名
+- [ ] 这是绑定层 (`chanlun-py`) 的功能需求
+- [ ] 这是核心层 (`chanlun`) 的算法需求
+- [ ] 这是全新的功能提案
+
+## 影响范围
+
+> 请勾选可能受影响的模块。
+
+- [ ] 类型定义 (`types/`)
+- [ ] K线层 (`kline/`)
+- [ ] 技术指标 (`indicators/`)
+- [ ] 笔划分 (`algorithm/bi`)
+- [ ] 线段划分 (`algorithm/segment`)
+- [ ] 中枢识别 (`algorithm/hub`)
+- [ ] 背驰检测 (`algorithm/divergence`)
+- [ ] 结构体 (`structure/`)
+- [ ] 观察者 (`business/observer`)
+- [ ] 买卖点 (`business/bsp`)
+- [ ] K线合成器 (`business/synthesizer`)
+- [ ] 立体分析器 (`business/multi_frame`)
+- [ ] 配置 (`config`)
+- [ ] Python 绑定 (`chanlun-py`)
+
+## 补充信息
+
+任何参考链接、图表、伪代码或其他有助于说明该功能的内容。