感谢你对 Hermes Agent 的贡献！本指南涵盖开发环境设置、理解代码库以及如何让你的 PR 被合并。 我们按以下顺序重视贡献： 1. Bug 修复 — 崩溃、不正确行为、数据丢失 2. 跨平台兼容性 — macOS、不同 Linux 发行版、WSL2 3. 安全加固 — Shell 注入、Prompt 注入、路
贡献指南
> 📖 本文档翻译自 Hermes Agent 官方文档 > 最后更新：2026-04-16
贡献指南
感谢你对 Hermes Agent 的贡献！本指南涵盖开发环境设置、理解代码库以及如何让你的 PR 被合并。
贡献优先级
我们按以下顺序重视贡献：
- Bug 修复 — 崩溃、不正确行为、数据丢失
- 跨平台兼容性 — macOS、不同 Linux 发行版、WSL2
- 安全加固 — Shell 注入、Prompt 注入、路径遍历
- 性能和健壮性 — 重试逻辑、错误处理、优雅降级
- 新技能 — 广泛有用的技能（参见创建技能）
- 新工具 — 很少需要；大多数功能应该是技能
- 文档 — 修复、澄清、新示例
常见贡献路径
- 想构建新工具？从添加工具开始
- 想构建新技能？从创建技能开始
- 想构建新的推理 Provider？从添加 Provider开始
开发环境设置
前置条件
| 要求 | 说明 |
|---|---|
| Git | 需支持 --recurse-submodules |
| Python 3.11+ | 缺失时 uv 会自动安装 |
| uv | Fast Python package manager (install) |
| Node.js 18+ | 可选——浏览器工具和 WhatsApp 桥接需要 |
克隆并安装
git clone --recurse-submodules https://github.com/NousResearch/hermes-agent.git
cd hermes-agent
# 使用 Python 3.11 创建虚拟环境
uv venv venv --python 3.11
export VIRTUAL_ENV="$(pwd)/venv"
# 安装所有扩展（消息、定时任务、CLI 菜单、开发工具）
uv pip install -e ".[all,dev]"
uv pip install -e "./tinker-atropos"
# 可选：浏览器工具
npm install
配置开发环境
mkdir -p ~/.hermes/{cron,sessions,logs,memories,skills}
cp cli-config.yaml.example ~/.hermes/config.yaml
touch ~/.hermes/.env
# 至少添加一个 LLM Provider 密钥：
echo 'OPENROUTER_API_KEY=*** >> ~/.hermes/.env
运行
# 创建全局访问的符号链接
mkdir -p ~/.local/bin
ln -sf "$(pwd)/venv/bin/hermes" ~/.local/bin/hermes
# 验证
hermes doctor
hermes chat -q "Hello"
运行测试
pytest tests/ -v
代码风格
- PEP 8，但允许实际例外（不强制行长度限制）
- 注释：仅在解释非显而易见的意图、权衡或 API 怪癖时使用
- 错误处理：捕获特定异常。对意外错误使用
logger.warning()/logger.error()并传入exc_info=True - 跨平台：永远不要假设 Unix（见下文）
- Profile 安全路径：永远不要硬编码
~/.hermes——代码路径使用hermes_constants中的get_hermes_home()，面向用户的消息使用display_hermes_home()。完整规则参见 AGENTS.md。
跨平台兼容性
Hermes 官方支持 Linux、macOS 和 WSL2。原生 Windows 不受支持，但代码库包含一些防御性编码模式以避免边缘情况下的硬崩溃。关键规则：
1. termios 和 fcntl 仅限 Unix
始终同时捕获 ImportError 和 NotImplementedError：
try:
from simple_term_menu import TerminalMenu
menu = TerminalMenu(options)
idx = menu.show()
except (ImportError, NotImplementedError):
# Fallback: numbered menu
for i, opt in enumerate(options):
print(f" {i+1}. {opt}")
idx = int(input("Choice: ")) - 1
2. 文件编码
某些环境可能以非 UTF-8 编码保存 .env 文件：
try:
load_dotenv(env_path)
except UnicodeDecodeError:
load_dotenv(env_path, encoding="latin-1")
3. 进程管理
os.setsid()、os.killpg() 和信号处理在不同平台上行为不同：
import platform
if platform.system() != "Windows":
kwargs["preexec_fn"] = os.setsid
4. 路径分隔符
使用 pathlib.Path 而不是用 / 进行字符串拼接。
安全注意事项
Hermes 拥有终端访问权限。安全很重要。
现有保护措施
| 层级 | 实现方式 |
|---|---|
| Sudo 密码管道 | 使用 shlex.quote() 防止 Shell 注入 |
| 危险命令检测 | tools/approval.py 中的正则模式，带用户审批流程 |
| Cron Prompt 注入 | 扫描器阻止指令覆盖模式 |
| 写入拒绝列表 | 受保护路径通过 os.path.realpath() 解析以防止符号链接绕过 |
| 技能防护 | Hub 安装技能的安全扫描器 |
| 代码执行沙盒 | 子进程运行时剥离 API 密钥 |
| 容器加固 | Docker：丢弃所有能力，无特权升级，PID 限制 |
贡献安全敏感代码
- 将用户输入插入 Shell 命令时始终使用
shlex.quote() - 访问控制检查前使用
os.path.realpath()解析符号链接 - 不要记录密钥
- 在工具执行周围捕获宽泛异常
- 如果你的更改涉及文件路径或进程，请在所有平台上测试
Pull Request 流程
分支命名
fix/description # Bug fixes
feat/description # New features
docs/description # Documentation
test/description # Tests
refactor/description # Code restructuring
提交前
- 运行测试：
pytest tests/ -v - 手动测试：运行
hermes并执行你更改的代码路径 - 检查跨平台影响：考虑 macOS 和不同 Linux 发行版
- 保持 PR 聚焦：每个 PR 一个逻辑变更
PR 描述
包含：
- 改了什么以及为什么改
- 如何测试
- 在哪些平台上测试过
- 引用任何相关的 issue
提交消息
我们使用 约定式提交：
<type>(<scope>): <description>
| 类型 | 用途 |
|---|---|
fix | Bug 修复 |
feat | 新功能 |
docs | 文档 |
test | 测试 |
refactor | 代码重构 |
chore | 构建、CI、依赖更新 |
范围：cli、gateway、tools、skills、agent、install、whatsapp、security
示例:
fix(cli): prevent crash in save_config_value when model is a string
feat(gateway): add WhatsApp multi-user session isolation
fix(security): prevent shell injection in sudo password piping
报告问题
- 使用 GitHub Issues
- 包含：操作系统、Python 版本、Hermes 版本（
hermes version）、完整错误堆栈 - 包含复现步骤
- 创建新 issue 前先检查是否已有重复
- 安全漏洞请私下报告
社区
- Discord: discord.gg/NousResearch
- GitHub Discussions：用于设计提案和架构讨论
- Skills Hub：上传专业技能并与社区分享
许可证
参与贡献即表示你同意你的贡献将在 MIT 许可证 下授权。