已开启
docs(contributing): 补充命名约定的两条说明 #5
docs(contributing): 补充命名约定的两条说明 #5
已开启
Melimeli创建于 8月15日
Melimeli
8月15日

背景

CONTRIBUTING.md 的「Naming」小节原仅要求 name 匹配 ^[a-zA-Z0-9._-]+$ 且唯一,未说明与目录名的关系,也未提保留字冲突风险——贡献者容易误以为目录名可与 name 不同,或起一个与官方插件前缀冲突的名字。

改动

在 Naming 小节补两条说明:

  • verified 插件目录名需与 name 完全一致——校验器强制,使安装路径可预测
  • 避开官方插件前缀(atomcode-workflows/commit-craft/git-worktree) 与去掉 plugin-name: 命名空间后与内置斜杠命令冲突的名字

验证

  • 仅修改 CONTRIBUTING.md,不影响插件结构与校验行为
  • python3 scripts/validate.py 能正常跑完(存量 ERROR 均为上游 catalog 已有问题,与本次改动无关)
likedislike
合并受阻
atomgit-bot
atomgit-bot成员
8月15日 评论:

变更摘要

本 PR 仅对 CONTRIBUTING.md 的「Naming」小节做了文档补充,围绕插件命名约定新增两条说明,用于消除贡献者对目录名与 name 关系、以及命名冲突风险的误解。此次改动不涉及插件结构、校验逻辑或运行行为。

主要改动

  • 补充 verified 插件目录名一致性要求:在 Naming 小节新增说明,要求 verified 插件的目录名与 name 完全一致,并由校验器强制校验,从而保证安装路径可预测。
  • 补充官方前缀与内置命令命名避让规则:新增说明要求避免使用官方插件前缀 atomcode-workflows、commit-craft、git-worktree,以及去掉 plugin-name: 命名空间后与内置斜杠命令冲突的名字。
likedislike
不准确?
atomgit-bot
atomgit-bot成员
8月15日 评论:

🤖 本次改动均为数据 / 生成 / 二进制文件(如测试用例、锁文件、媒体资源),没有可审查的代码逻辑,已跳过 AI 代码审查。

likedislike
不准确?
atomgit-bot
atomgit-bot成员
8月15日 评论:

AtomGit AI 助手使用指南

在 PR 评论中使用命令即可触发。支持在普通评论和代码行评论中使用。

功能 命令 说明
代码审查 /ai review 检查代码质量、潜在问题、安全风险
PR 摘要 /ai summary 生成 PR 变更内容的结构化摘要
代码解释 /ai explain 解释代码变更的逻辑和意图
自由提问 @atomgit-bot <问题> 询问关于本 PR 的任何问题
帮助 /ai help 显示此帮助信息

免责声明

AI 助手可能存在误判,请结合自身判断。可以对评论点 👍 或 👎 帮助我们改进。

likedislike
不准确?