CONTRIBUTING.md

贡献指南

感谢您考虑为VPN端口映射工具做出贡献！以下是一些指导原则，帮助您参与项目开发。

报告问题

如果您发现了bug或有功能建议，请通过GitHub Issues提交。提交问题时，请包含以下信息：

• 问题的详细描述
• 复现步骤（如适用）
• 您的操作系统和Linux发行版信息
• 错误日志（如有）
• 期望的行为

提交代码

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

代码风格

• 使用4个空格缩进
• 为函数和复杂代码块添加注释
• 变量和函数名使用小写字母和下划线（例如：check_network）
• 常量使用大写字母（例如：VERSION）

开发指南

项目结构

.
├── install.sh          # 安装脚本
├── vpn.sh              # 主程序脚本
├── test_mapping.sh     # 测试脚本
├── README.md           # 项目说明文档
├── LICENSE             # 许可证文件
└── CONTRIBUTING.md     # 贡献指南

添加新功能

添加新功能时，请遵循以下步骤：

1. 在vpn.sh中添加新函数
2. 更新菜单和命令行参数处理逻辑
3. 添加相应的日志记录
4. 更新README.md中的功能说明
5. 编写测试用例（如适用）

测试

在提交代码前，请确保：

1. 在至少一种Linux发行版上测试您的更改
2. 所有现有功能仍然正常工作
3. 新功能按预期工作
4. 错误处理正常

版本控制

我们使用语义化版本控制。版本号格式为：主版本.次版本.修订版本

• 主版本：不兼容的API更改
• 次版本：向后兼容的功能添加
• 修订版本：向后兼容的bug修复

许可证

通过贡献代码，您同意您的贡献将在MIT许可证下发布。

联系方式

如有任何问题，请通过GitHub Issues联系我们。

感谢您的贡献！