Skip to content

Latest commit

 

History

History
52 lines (37 loc) · 1.34 KB

File metadata and controls

52 lines (37 loc) · 1.34 KB

贡献指南 (Contributing Guide)

感谢你对舒尔特方格项目的关注!

如何贡献

报告 Bug

  1. Issues 中搜索是否已有相关报告
  2. 如果没有,使用 Bug Report 模板创建新 Issue
  3. 清晰描述:复现步骤、预期行为、实际行为、设备信息

提出新功能

  1. Issues 中搜索是否已有类似请求
  2. 使用 Feature Request 模板创建新 Issue
  3. 描述功能的使用场景和价值

提交代码

  1. Fork 本仓库
  2. 创建功能分支:git checkout -b feature/amazing-feature
  3. 编写代码,遵循项目风格
  4. 确保代码可编译:./gradlew assembleDebug
  5. 提交更改:git commit -m 'feat: add amazing feature'
  6. 推送到分支:git push origin feature/amazing-feature
  7. 创建 Pull Request

Commit 规范

本项目使用 Conventional Commits 规范:

  • feat: 新功能
  • fix: 修复 Bug
  • docs: 文档变更
  • style: 代码格式(不影响功能)
  • refactor: 重构
  • perf: 性能优化
  • test: 测试相关
  • chore: 构建/工具变更

代码风格

  • 使用 Kotlin 官方代码风格
  • Compose UI 组件使用函数式写法
  • 命名遵循 Android Kotlin 命名规范

开发环境

  • Android Studio Hedgehog (2024.1.1) 或更高
  • JDK 17+
  • Kotlin 2.0+