109 lines
2.2 KiB
Markdown
109 lines
2.2 KiB
Markdown
# SkyLink 贡献指南
|
||
|
||
感谢您对 SkyLink 项目的关注！我们欢迎各种形式的贡献。
|
||
|
||
## 🐛 报告问题
|
||
|
||
如果您发现任何 bug，请通过以下方式报告：
|
||
|
||
1. **检查现有 Issue** - 确保该问题还没被报告
|
||
2. **创建新 Issue** - 提供详细的错误描述、复现步骤和环境信息
|
||
|
||
### Issue 模板
|
||
|
||
```
|
||
## 问题描述
|
||
清晰地描述您遇到的问题
|
||
|
||
## 复现步骤
|
||
1. ...
|
||
2. ...
|
||
3. ...
|
||
|
||
## 预期行为
|
||
应该发生什么
|
||
|
||
## 实际行为
|
||
实际上发生了什么
|
||
|
||
## 环境信息
|
||
- 系统: Linux / Windows / macOS
|
||
- 编译器: gcc / clang / MSVC
|
||
- 其他相关信息
|
||
```
|
||
|
||
## 📝 提交 Pull Request
|
||
|
||
1. **Fork** 本仓库
|
||
2. **创建特性分支** (`git checkout -b feature/amazing-feature`)
|
||
3. **提交更改** (`git commit -m 'Add amazing feature'`)
|
||
4. **推送分支** (`git push origin feature/amazing-feature`)
|
||
5. **创建 Pull Request**
|
||
|
||
### PR 检查清单
|
||
|
||
- [ ] 代码遵循项目的编码规范
|
||
- [ ] 添加了必要的注释和文档
|
||
- [ ] 更新了相关的 README
|
||
- [ ] 没有引入新的警告或错误
|
||
- [ ] 所有测试都通过了
|
||
|
||
## 📚 开发规范
|
||
|
||
### C++ 代码规范
|
||
|
||
- 使用 Google C++ Style Guide (改进版)
|
||
- 变量名: `snake_case`
|
||
- 类/结构体: `PascalCase`
|
||
- 常量: `UPPER_SNAKE_CASE`
|
||
- 成员变量: `snake_case_` (末尾下划线)
|
||
- 方法: `camelCase` 或 `snake_case`
|
||
|
||
### Kotlin 代码规范
|
||
|
||
- 遵循 Kotlin 官方编码规范
|
||
- 使用 Kotlin idioms
|
||
- 避免 Java 风格的代码
|
||
|
||
### 注释规范
|
||
|
||
- 使用中英文混用（优先中文）
|
||
- 关键逻辑必须有说明
|
||
- 使用 Doxygen 风格的文档注释
|
||
|
||
## 🧪 测试
|
||
|
||
在提交 PR 之前，请确保：
|
||
|
||
1. 编译不出错
|
||
2. 没有新的警告
|
||
3. 功能正常工作
|
||
4. 不会破坏现有功能
|
||
|
||
## 📖 改进文档
|
||
|
||
文档改进总是受欢迎的！您可以：
|
||
|
||
- 修正拼写错误
|
||
- 改进说明和示例
|
||
- 添加新的教程
|
||
- 翻译文档
|
||
|
||
## 🎨 改进设计
|
||
|
||
如果您有关于 UI/UX 的建议，请：
|
||
|
||
1. 创建一个 Issue 讨论
|
||
2. 提供设计草图或截图
|
||
3. 解释您的改进理由
|
||
|
||
## 💬 联系我们
|
||
|
||
- **邮件**: support@skylink.dev
|
||
- **讨论**: GitHub Discussions
|
||
- **问题**: GitHub Issues
|
||
|
||
---
|
||
|
||
**感谢您的贡献！** 🎉
|