Skip to content

docs: 统一项目命名规范 - #6

Open
borankux wants to merge 1 commit into
JamesShi96:mainfrom
borankux:codex/naming-conventions
Open

docs: 统一项目命名规范#6
borankux wants to merge 1 commit into
JamesShi96:mainfrom
borankux:codex/naming-conventions

Conversation

@borankux

@borankux borankux commented Jun 10, 2026

Copy link
Copy Markdown

摘要

  • 将中文 README 从 README_zh.md 调整为 README.zh.md,并更新当前文档中的引用。
  • 新增 docs/naming-conventions.md,明确仓库文件命名、保留入口文件例外、以及生成到用户项目中的记忆文件例外。
  • 将当前协议文档中的 .claude/.file-snapshot.json 调整为 .claude/file-snapshot.json,并在升级说明中保留旧路径迁移规则。

为什么需要这个改动

Project Butler 本身就是一个帮助项目建立文件秩序和长期记忆的 Skill,所以仓库自身的命名规则最好也能清晰、可解释。此前仓库中同时存在下划线、点前缀状态文件、kebab-case、全大写协议文件等多种风格,但没有一份文档解释哪些是约定、哪些是例外。

这个 PR 的目标不是重命名所有文件,而是把规则写清楚:

  • README.mdLICENSESKILL.md 保留生态约定命名。
  • PROJECT.mdTODO.mdUPDATE_LOG.md 等生成文件保留协议命名。
  • 仓库自有文档默认使用 kebab-case
  • 语言版本使用点后缀,例如 README.zh.md

这样后续新增文档时,可以有一个明确的命名参考,减少风格继续发散。

兼容性

  • 不重写历史日志和旧 update log 条目。
  • 已存在 .claude/.file-snapshot.json 的项目通过 upgrade 说明迁移,不静默破坏。
  • UPDATE_LOG.md 保持不变,因为它已经是项目记忆协议的一部分。

验证

  • 搜索当前活跃文档中的 README_zh.md.claude/.file-snapshot.json 引用。
  • 确认保留下来的旧 snapshot 路径只出现在兼容迁移说明中。

@borankux borankux changed the title docs: standardize naming conventions docs: 统一项目命名规范 Jun 10, 2026
@borankux
borankux marked this pull request as ready for review June 10, 2026 08:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants