当前 2x 分支为默认分支,1x 分支为归档版本。
我们欢迎社区成员贡献新的模块!提出 issue 可以添加您的模块/适配器/CLI 拓展到库中。
我们采用 PyPI 包的方式管理模块。贡献者只需将模块发布到 PyPI,然后通过 issue 提交相关信息即可。
请确保满足以下要求:
- 模块代码符合 ErisPulse 开发规范
- 提供完整的文档和使用说明
- 确保无版权问题,允许我们修改与发布
- 模块已在 PyPI 发布
-
将模块发布到 PyPI
使用
twine或其他工具将您的 Python 包发布到 PyPI:python -m build twine upload dist/* -
提交 Issue
访问仓库的 Issues 页面,使用"模块/适配器/CLI扩展提交"模板创建一个新的 issue,填写以下信息:
- 提交类型:模块 (Module)、适配器 (Adapter) 或 CLI 扩展 (CLI Extension)
- 基本信息:名称、描述、作者、仓库地址
- 技术信息:最低 SDK 版本要求、依赖项
- PyPI 包名:确保已在 PyPI 发布
- 其他信息:标签、是否官方维护等
-
审核与合并
我们将审核您的提交。审核通过后,会将您的模块信息添加到
packages.json中,使其可以被 ErisPulse 生态系统发现和使用。
在提交前,请确认:
- 代码遵循 ErisPulse 开发规范
- 包含适当的文档
- 包含测试用例(如适用)
- 已在 PyPI 发布