社区拓展指南:如何提交扩展

本文说明如何向 msServiceProfiler 社区提交第三方插件或配置方案,以及审核通过后的处理方式。


准备工作

1. 满足收录条件

  • 代码托管在公开仓库(GitCode/GitHub/GitLab/Gitee 等)
  • 仓库中包含 LICENSE 或明确的许可证说明
  • 有基本 README(用途、使用方式)
  • msServiceProfiler 使用场景相关
  • 至少有一个可用的版本或可用的配置说明

2. 许可证建议

类型 常见许可证
推荐 MIT、Apache-2.0、BSD-2-Clause、BSD-3-Clause
需注意 GPL-3.0、AGPL-3.0(衍生作品可能需开源)
避免 无明确许可证、纯商业闭源(除非有免费/开源部分并写清)

提交流程

  1. 新建 Issue
    打开 本仓库 Issue 页面,点击「新建」并选择 「🔌 扩展提交」 模板(扩展提交模板)。

  2. 填写模板
    按模板填写:扩展名称、描述、仓库链接、许可证、分类(插件 / 配置方案 / 其他)、维护者等;可选填写版本、兼容性、文档/截图链接。

  3. 等待审核
    维护者会在 1~3 个工作日 内在本 Issue 下回复;如需补充或修改,请在同一 Issue 中更新或回复。

  4. 通过后
    审核通过后,维护者会手动将扩展信息加入 社区扩展与插件列表 的对应分类表格中。


信息填写参考

模板中的字段与填写示例(与 Issue 模板一致):

扩展名称: "my-profiler-plugin"
一句话描述: "为 msServiceProfiler 提供 XXX 场景的配置模板"
完整描述: "详细说明功能、适用场景、与 msServiceProfiler 的关系"

仓库地址: "https://gitcode.com/username/repo"
许可证类型: "MIT"

分类: 插件   # 或 配置方案 / 其他
维护者: "@yourusername"

可选:当前版本、兼容的 msServiceProfiler 版本、依赖项、文档/演示链接。


审核标准

维度 通过要求 可能拒绝的情况
完整性 必填信息完整、可访问 缺少仓库、许可证、描述等
相关性 与 msServiceProfiler 使用场景相关 与项目无关
许可证 有明确开源许可证 无许可证或未说明
可维护性 有 README、可理解用途 无说明、无法判断用途

更新已收录的扩展

若您的扩展已被收录,需要更新描述、链接或版本:

  1. 在原提交的 Issue 下回复(若已关闭可新开 Issue 并注明原 Issue 或扩展名)
  2. 说明更新内容(如新版本号、新链接、描述变更)
  3. 维护者会更新 community_extensions.md 中对应条目

移除扩展

出现以下情况时,维护者可能从列表中移除该扩展:

  • 仓库删除或设为私有
  • 长期无更新(如超过 2 年)且无法确认是否仍可用
  • 许可证变更后不符合收录要求
  • 存在安全或合规问题
  • 作者明确要求移除

如有疑问,可在本仓库提 Issue 并选择合适类型进行咨询。