Markdown 文件正在成为新的 dot files 吗?

发布: (2026年2月21日 GMT+8 17:01)
2 分钟阅读
原文: Dev.to

Source: Dev.to

背景

SymfonyAstroOllama 这样的项目通常会把点文件(例如 .gitignore.env)放在仓库的顶层。

随着 AI 工具的兴起,类似 CLAUDE.mdAGENTS.md 等新的 markdown 文件也开始出现在根目录中。

Markdown 配置文件的问题

  • 缺乏上下文 – 与其他非点文件一样,这些 markdown 文件如果没有额外的文档说明,往往难以定位和理解。
  • 根目录杂乱 – 向仓库根目录添加更多文件会使项目结构更难浏览。

可能的解决方案

  1. 创建专用文件夹
    将所有与配置相关的 markdown 文件放入 .tools(或类似)目录。

    # Example directory structure
    .
    ├── src/
    ├── .tools/
       ├── CLAUDE.md
       └── AGENTS.md
    └── Makefile
  2. 使用 Makefile(或类似)为工具创建别名
    定义指向专用文件夹内配置文件的目标。

    # Makefile example
    claude:
    	@echo "Running Claude with config .tools/CLAUDE.md"
    	# command that uses the config file
    
    agents:
    	@echo "Running Agents with config .tools/AGENTS.md"
    	# command that uses the config file
  3. 在 markdown 文件内部进行作用域划分
    有些开发者建议直接在 CLAUDE.md 等文件内部添加作用域机制,以免需要单独的目录。

讨论

是否该通过将 AI 相关的 markdown 文件移入专用目录并使用别名的方式,来清理应用程序的根文件夹?这种做法可以提升组织性,减少杂乱,并让每个文件的用途更加明确。

0 浏览
Back to Blog

相关文章

阅读更多 »