DEVELOPER DOCUMENTATION
文档
这里记录公开工程层的使用方式、接口、示例和生态规则。 内部研究映射与未公开技术不属于公开文档范围。
概览
Lishu Open Technology 面向开发者和研究者提供公开基础实现。 你可以阅读代码、运行示例、修改实现, 也可以在此基础上探索新的系统结构。
公开工程原则
公共文档重点回答: 如何使用、如何组合、如何测试、如何扩展。 不要求开发者理解任何内部理论来源。
快速开始
git clone https://github.com/Jugan65/lishu.git
cd lishu
# 查看项目
ls
# 阅读 README
cat README.md
具体算法源码和运行方式将在对应模块发布后补充。
推荐项目结构
lishu/
├── core/
├── modules/
├── examples/
├── docs/
├── architecture-cards/
├── tests/
├── .github/
└── README.md
公开工程原则
- 接口和行为尽量清楚。
- 公开代码不需要解释内部命名来源。
- 公共实现与商业私有模块保持仓库隔离。
- 公开仓库不得提交 Secret、Token、私有 API Key 或客户数据。
- 破坏兼容性的重大修改使用新的版本号。
参与生态
你可以通过 GitHub Discussions 分享实验、想法和新的架构。 如果希望新的结构进入 Architecture Registry, 可以提交 Architecture Card。
安全问题
请不要通过公开 Issue 提交敏感漏洞、凭证或客户数据。
安全相关问题请联系: security@lishudijun.com