Skip to content

contributing.md

Latest commit

 

History

History
80 lines (55 loc) · 2.05 KB

contributing.md

File metadata and controls

80 lines (55 loc) · 2.05 KB

贡献指南

本文档介绍如何为 malice-network 项目进行开发和贡献。

参与方式

Issue Reporter

通过深度使用 IoM 发现问题：

  • 提交 bug 报告（附带复现步骤）
  • 提出功能需求和改进建议
  • 反馈不合理的设计和低级 bug
  • 指出文档中的错误描述、歧义等

Contributor

协助解决具体问题：

  1. 分析并定位问题
  2. 编写修复代码
  3. 完成测试验证
  4. 提交 Pull Request

Core Contributor

参与新功能开发和架构优化：

  1. 发起需求并讨论技术方案
  2. 实现完整功能模块
  3. 参与 Code Review 和迭代优化

环境配置

??? important "Go 开发环境" 版本要求 : Go >= 1.25

```bash
go version
```

??? important "protobuf / gRPC 环境" 日常 Client / Server 功能开发通常不需要重新生成 protobuf。

只有修改协议或 `external/IoM-go` 子模块时，才需要安装 `protoc` 与 Go 插件，并在子模块内完成生成流程。不要手动编辑生成的 Go 代码。

```bash
protoc --version
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.3.0
go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.34.1
```

PR 合并流程

  1. 角色分配 ：每个复杂功能分配一个 Maintainer 和至少一个 Assignee
  2. Review 流程 ：Maintainer 完成后通知 Assignee 进行 review 和测试
  3. 文档要求 ：
    • PR 中附上测试截图和用法说明
    • 新功能需添加对应的 help 信息
    • 系统性功能 PR 通过后立即编写相关文档

Pre-commit 检查

go vet ./...                            # 静态分析
go test ./... -count=1 -timeout 300s    # 测试
CGO_ENABLED=0 go build ./...            # 编译验证

如果修改了依赖、go.mod，或 external/ 子模块相关内容，再运行：

go mod tidy

相关文档