CONTRIBUTING.md

贡献指南 (Contributing to Cerberus)

感谢你对 Cerberus 感兴趣！我们需要你的帮助来让它成为最好的安全测试平台。

开发环境搭建

前置要求

• Linux 或 macOS (Windows 支持目前处于实验阶段)
• Python 3.13+
• C++ 编译器 (GCC 9+ 或 Clang 10+)
• CMake 3.20+
• Poetry

步骤

1. Fork 并克隆仓库

   git clone https://github.com/YOUR_USERNAME/Cerberus.git
   cd Cerberus

2. 安装依赖并编译 我们使用 Poetry 管理 Python 依赖，scikit-build-core 自动处理 C++ 编译。

   poetry install

   或者手动安装：

   poetry run pip install scikit-build-core pybind11
   poetry run pip install -e . --no-build-isolation

3. 运行测试

   poetry run pytest

代码规范

Python

• 遵循 PEP 8 规范。
• 使用 Type Hints (类型提示)。
• 使用 black 进行代码格式化。

C++

• 遵循现代 C++ (C++17) 风格。
• 类名使用 PascalCase，变量和函数使用 snake_case 或 camelCase (保持一致)。
• 头文件使用 #pragma once。
• 注释: 只允许使用 /**/ 风格，禁止使用 //。

提交 Pull Request

1. 基于 main 分支创建一个新的功能分支：git checkout -b feature/my-new-feature。
2. 提交你的更改，请编写清晰的提交信息。
3. 推送到你的 Fork：git push origin feature/my-new-feature。
4. 在 GitHub 上提交 Pull Request。

报告 Bug

请使用 GitHub Issues 报告 Bug。报告时请包含：

• 操作系统版本
• Python 和编译器版本
• 复现步骤
• 错误日志