> ## Documentation Index
> Fetch the complete documentation index at: https://docs.newenergycoder.club/llms.txt
> Use this file to discover all available pages before exploring further.

# 贡献指南

> 如何为 NEC 新能源开发者社区做出贡献

## 欢迎贡献

感谢你对 NEC 新能源开发者社区的兴趣！我们欢迎各种形式的贡献：

* 🐛 报告 Bug
* 💡 提出新功能建议
* 📝 改进文档
* 🔧 提交代码修复
* ✨ 添加新功能

## 行为准则

### 我们的承诺

为了营造一个开放和友好的环境，我们作为贡献者和维护者承诺：

* 尊重不同的观点和经验
* 优雅地接受建设性批评
* 关注对社区最有利的事情
* 对其他社区成员表示同理心

### 我们的标准

积极行为包括：

* 使用友好和包容的语言
* 尊重不同的观点和经验
* 优雅地接受建设性批评
* 关注对社区最有利的事情
* 对其他社区成员表示同理心

不可接受的行为包括：

* 使用性化语言或图像
* 挑衅、侮辱/贬低评论、人身或政治攻击
* 公开或私下骚扰
* 未经明确许可发布他人的私人信息
* 其他在专业环境中被认为不适当的行为

## 如何贡献

### 报告 Bug

如果你发现了 Bug，请通过 [Issue](https://gitee.com/darrenpig/new_energy_coder_club/issues) 报告，并包含以下信息：

* **标题**：清晰描述问题的简短标题
* **描述**：详细描述问题
* **复现步骤**：如何复现该问题
* **预期行为**：你期望发生什么
* **实际行为**：实际发生了什么
* **环境信息**：操作系统、软件版本等
* **截图/日志**：如有必要，附上截图或日志

### 提出功能建议

如果你有新功能建议，请创建 Issue 并包含：

* **功能描述**：清晰描述你想要的功能
* **使用场景**：这个功能在什么情况下有用
* **预期行为**：功能应该如何工作
* **替代方案**：你考虑过的其他解决方案

### 提交代码

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

## Pull Request 流程

1. 确保你的代码符合我们的代码规范
2. 更新相关文档
3. 确保所有测试通过
4. 等待代码审查
5. 根据反馈进行修改

## 文档模板

为保持项目与竞赛文档结构一致，建议直接使用社区提供的模板：

* [项目文档模板](/templates/project-template) — 适用于开源项目、赛季仓库的 README 与说明页
* [竞赛文档模板](/templates/competition-template) — 适用于 ROBOCON、节能减排等竞赛的规则解读、方案与复盘页

新建页面时，请先复制对应模板，再替换内容；修改模板本身前请在社区群内同步。

## 代码审查

所有提交都需要经过代码审查。审查者会关注：

* 代码质量
* 功能正确性
* 文档完整性
* 测试覆盖率

## 许可证

通过贡献你的代码，你同意你的贡献将在项目使用的开源许可证下发布。