CONTRIBUTING.md

VulnArk 贡献指南

感谢您考虑为 VulnArk 项目做出贡献！本文档提供了参与项目开发的指南和流程说明。

行为准则

本项目采用了贡献者公约，我们希望所有参与者都能遵守这一准则。请以尊重和建设性的方式参与，确保项目社区的开放性和包容性。

如何贡献

有多种方式可以为VulnArk做出贡献：

1. 报告错误和提交功能需求
2. 提交修复或新功能的代码
3. 改进或翻译文档
4. 帮助回答使用问题或参与讨论

报告问题

如果您发现错误或有功能建议，请使用GitHub的Issue系统进行报告：

1. 搜索现有的Issues，确保问题尚未被报告
2. 使用相应的问题模板创建新Issue
3. 提供尽可能详细的信息，包括：
   • 问题描述
   • 复现步骤
   • 预期行为
   • 实际行为
   • 系统环境和版本信息
   • 相关的截图或日志

提交代码

如果您希望为项目贡献代码，请遵循以下流程：

1. Fork项目仓库
2. 创建特性分支：git checkout -b feature/your-feature-name
3. 提交您的更改：git commit -m 'Add some feature'
4. 推送到分支：git push origin feature/your-feature-name
5. 创建Pull Request

开发环境设置

要设置本地开发环境，请按照以下步骤操作：

前端开发：

cd frontend
npm install
npm run serve

后端开发：

cd backend
go mod download
go run main.go

编码标准

• 前端：遵循Vue.js风格指南，使用ESLint进行代码风格检查
• 后端：遵循Go语言官方规范，使用gofmt格式化代码
• 文档：使用Markdown格式，确保清晰易读

提交信息规范

请使用简明扼要的提交信息，遵循以下格式：

类型(范围): 简短描述

详细描述（如有必要）

其中类型可以是：

• feat: 新功能
• fix: 修复Bug
• docs: 文档变更
• style: 代码风格改动（不影响功能）
• refactor: 代码重构
• perf: 性能优化
• test: 添加或修改测试
• chore: 构建过程或辅助工具变动

示例：

feat(user): 添加用户角色过滤功能

添加了按用户角色进行筛选的功能，使管理员能够更容易找到特定角色的用户。

文档贡献

良好的文档对于项目至关重要。如果您发现文档中的问题或希望改进文档，可以：

1. 修正拼写或语法错误
2. 改进现有文档的清晰度和准确性
3. 添加缺少的文档或示例
4. 翻译文档到其他语言

Pull Request审核流程

所有Pull Request会由维护者进行审核。审核可能要求进行更改才能被接受。审核过程中请注意：

1. 确保通过所有自动化测试
2. 响应审核意见并进行必要的修改
3. 保持耐心，不同时区的审核者可能需要时间进行回复

许可证

通过为本项目做出贡献，您同意您的贡献将在MIT许可证下发布。