本文目录导读:

开源项目的“默认语言”通常指两个方面:代码中的用户界面语言(如系统提示、注释)和项目文档/社区沟通的主语言,以下分场景说明如何设置:
代码与UI的默认语言(主要针对软件项目)
- 原则:通常强制使用英语(即使是中文或其它语言项目,核心代码注释、变量名、提交信息也建议用英文,便于全球协作)。
- 如何操作:
- 在代码仓库根目录创建
README.md(或README文件),用英文书写项目简介、安装步骤。 - 如果项目有内置多语言支持:
- 使用 i18n(国际化) 框架,将
en.json或en.yaml作为默认语言文件。 - 在代码中设置回退(fallback)语言为英语(如
vue-i18n的fallbackLocale: 'en')。
- 使用 i18n(国际化) 框架,将
- 注释:默认用英文写,但可以允许中文(或其它语言)辅助说明。
- 在代码仓库根目录创建
项目文档与社区沟通的默认语言(GitHub/GitLab等平台)
- 原则:推荐双语或纯英文,若主要用户是特定语言群体,可设置该语言为主,但建议同时提供英文版。
- 如何设置:
- GitHub项目设置:
- 进入仓库 → Settings → General → 最下方 “Community” 板块。
- 在 “Project state” 或类似区域,可以设置
Default language(但GitHub会根据代码文件自动检测语言,无法手动覆盖)。
*注:这里的语言指代码语言(如JavaScript、Python),不是人类语言。
- 文档主语言:
在README.md开头用一级标题标注语言:# Project Name (English) [中文版本](./README_zh.md)
或使用
docs/目录按语言分文件夹:docs/en/,docs/zh/。 - Issue/PR模板:
创建ISSUE_TEMPLATE和PULL_REQUEST_TEMPLATE时,用英文写主干,同时可添加[中文]版可选模板。
- GitHub项目设置:
特殊情况:中文开源项目
- 若项目完全面向中文用户(如国产工具、政府相关库),可设置中文为默认:
README.md用中文,README_EN.md为英文版。- 在
package.json或setup.py等配置文件中添加"defaultLanguage": "zh-CN"字段(非标准,但可作约定)。 - 代码注释仍建议中英混合,但核心功能注释用英文确保可移植性。
工具与自动化建议
- 使用 Crowdin 或 Weblate 管理多语言翻译,并设置主语言。
- 在
.github/labeler.yml或CODEOWNERS中标记语言相关的文件,# 英文文档由@en-team维护 docs/en/*: @en-team
| 场景 | 默认语言 | 推荐做法 |
|---|---|---|
| 代码注释/变量 | 英语 | 强制要求英文,避免乱码和协作障碍 |
| README(主) | 英语 | 提供README_zh.md等翻译版本 |
| Issue/PR | 英语(可加中文说明) | 模板用英文,允许中文回复 |
| 纯中文社区项目 | 中文 | 主文档用中文,附加英文摘要 |
| 平台语言检测 | 自动识别(一般无法手动改) | 无需干预,除非代码只有一种语言 |
最佳实践:无论项目主要用户是谁,至少保留一份完整的英文文档——它不仅是默认语言,更是开源协作的“通用语言”。