docs: 统一项目命名规范 - #6
Open
borankux wants to merge 1 commit into
Open
Conversation
borankux
marked this pull request as ready for review
June 10, 2026 08:43
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
摘要
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.md、LICENSE、SKILL.md保留生态约定命名。PROJECT.md、TODO.md、UPDATE_LOG.md等生成文件保留协议命名。kebab-case。README.zh.md。这样后续新增文档时,可以有一个明确的命名参考,减少风格继续发散。
兼容性
.claude/.file-snapshot.json的项目通过 upgrade 说明迁移,不静默破坏。UPDATE_LOG.md保持不变,因为它已经是项目记忆协议的一部分。验证
README_zh.md和.claude/.file-snapshot.json引用。