动态组件发布
# 发布至 RuleGo Marketplace
RuleGo Marketplace 欢迎来自合作伙伴和社区开发者的组件/规则链上架申请,您的贡献将进一步丰富 RuleGo 的生态。 组件/规则链合并到主分支后会同步到RuleGo Marketplace (opens new window) 提供给用户使用。
# 组件的发布流程
将组件发布至 RuleGo Marketplace 包含以下步骤:
# 1. 完成组件开发与测试
- 确保您的组件已通过充分的测试,功能稳定且无明显漏洞。
- 组件应遵循 RuleGo 的设计规范和最佳实践。
- 组件的 DSL 文件应完整且符合 RuleGo 的 DSL 规范。
# 2. 准备组件发布材料
- 组件的 DSL 文件(JSON 格式)。
- 组件的详细说明文档,包括功能描述、使用指南、参数说明等。
- 组件的版本信息。
# 3. 提交组件至 RuleGo Marketplace
- 将组件的 DSL 文件和相关材料提交至 RuleGo 的组件仓库:rulego-components-marketplace (opens new window)
- 创建一个新的 Pull Request (PR),按照仓库中的 PR Template 格式填写相关信息。
- 在 PR 中详细描述组件的功能、用途、安装方式等。
- 确保 PR 中的文件和信息完整且准确。
# 4. 组件审核
- RuleGo 团队将对提交的组件进行审核,审核内容包括但不限于:
- 组件的功能性和稳定性。
- 组件是否符合 RuleGo 的设计规范和最佳实践。
- 组件的文档是否完整且清晰。
- 组件的 DSL 文件是否符合规范。
- 审核将在 1 周内开始,如有延迟,审核人员将通过评论通知 PR 作者。
- 在审核期间,作者需要积极回应审核人员的提问和反馈,未解决的 PR 评论将被标记为过时(可重新开启),超过 30 天未解决的 PR 评论将被关闭(不可重新开启,需要创建新 PR)。
- 组件合并到主分支后会同步到ruleGo Marketplace 提供给用户使用。
# 5. 组件发布
- 组件审核通过后,将正式上线至 RuleGo Marketplace。
- 作者需要持续维护组件,处理用户报告的问题和功能请求。
- 在发生重大 API 变更时,作者需要及时迁移组件,RuleGo 团队将提前发布变更通知和迁移说明,并提供必要的迁移支持。
# 注意事项
- 组件的独特性:确保您的组件具有独特的功能和价值,避免与现有组件功能重复。如果您的组件是对现有组件的优化或改进,需确保改进显著且具有实际意义。
- 组件的兼容性:确保组件与 RuleGo 的当前版本兼容,并在描述中明确支持的版本范围。
- 组件的安全性:确保组件不包含任何恶意代码或安全漏洞。
通过以上步骤,您的组件将能够顺利发布至 RuleGo Marketplace,为社区带来价值并获得广泛的应用和认可。
在 GitHub 上编辑此页 (opens new window)
上次更新: 2025/03/30, 16:14:27