参与贡献 Strix

感谢你对 Strix 的关注。本文档用于帮助你快速进入 strix-cn 的开发与贡献流程。

分支定位

strix-cn 是面向中文用户的持续维护分支。提交改动时，请优先考虑以下方向：

国内可访问、可落地的模型接入与兼容网关
Burp Suite / Burp 插件工作流兼容
macOS、Linux、Windows 与受限网络环境兼容性
中文文档、中文说明与中文报告体验

开发环境准备

前置要求

Python 3.12+
Go 1.24.x（仅在开发或打包新的 Bubble Tea TUI sidecar 时需要）
Docker（已启动）
uv（用于依赖管理）
Git

本地开发

克隆仓库

git clone https://github.com/usestrix/strix.git
cd strix

安装开发依赖

make setup-dev

# 或手动执行：
uv sync
uv run pre-commit install

配置 LLM 提供商

export STRIX_LLM="openai/your-compatible-model"
export LLM_API_KEY="your-api-key"
export LLM_API_BASE="https://your-gateway.example/v1"

以开发模式运行 Strix

uv run strix --target https://example.com

贡献 Skills

Skills 是用于增强代理能力的专业知识包。详细规范请查看 strix/skills/。

选择合适的分类目录。
创建 .md 文件并写入 skill 内容。
提供可操作示例，例如 payload、命令或测试用例。
补充验证方法，说明如何确认发现结果并避免误报。
通过 PR 提交，并写清楚背景与目标。

贡献代码

Pull Request 流程

先创建 Issue，描述问题或功能需求。
Fork 并创建分支；若同步上游能力，请在描述中说明来源与适配范围。
完成修改，遵循项目现有代码风格。
编写或更新测试，确保新功能和修复有覆盖。
运行质量检查，make check-all 应通过。
提交 PR，关联 Issue，并提供足够上下文。

代码风格

遵循 PEP 8，单行长度上限 100。
所有函数都应提供类型标注。
公共方法应编写 docstring。
保持函数职责单一、规模适中。
变量命名应清晰可读。

本地 Viewer SPA

strix view 服务的预构建 Web UI 源码位于 strix/interface/viewer/frontend/，构建产物提交在 strix/interface/viewer/static/ 并随包发布。最终用户不需要自行构建前端。

如果你修改了 viewer/frontend/ 下的内容，请重新构建并一并提交：

make viewer

等价命令：

cd strix/interface/viewer/frontend
npm run build

打包说明

可编辑安装不要求提前构建 Go sidecar；开发模式会直接从源码运行 TUI。

wheels 会强制打包与当前版本匹配的 Go sidecar，并且是平台相关的：

make wheel

构建钩子 scripts/tui_sidecar_hook.py 会编译 sidecar、嵌入为 strix/bin/strix-tui，并写入当前平台 tag。scripts/build.sh 与 strix.spec 也依赖同一套 sidecar 产物。

提交问题

提交 Bug 时，请尽量附带以下信息：

Python 版本与操作系统
Strix 版本
使用的 LLM
完整错误堆栈
复现步骤
预期行为与实际行为

社区

Discord：加入社区
Issues：GitHub Issues

致谢

我们重视每一份贡献。欢迎通过 Issue、PR 和社区讨论一起把 strix-cn 持续打磨好。

FilesExpand file tree

CONTRIBUTING.md

Latest commit

History