Skip to content

CONTRIBUTING.zh.md

Latest commit

 

History

History
69 lines (47 loc) · 1.85 KB

CONTRIBUTING.zh.md

File metadata and controls

69 lines (47 loc) · 1.85 KB

贡献 OCTO（简体中文）

感谢你有兴趣贡献 OCTO！🐙 我们欢迎任何规模的贡献。

开始之前

  1. Fork 仓库，并从 main 创建你的分支
  2. 安装依赖 — 参考仓库 README
  3. 进行修改 — 遵循项目既有代码风格
  4. 补充测试 — 修复 bug 或新增功能时请附带测试
  5. 更新文档 — 行为变化请同步更新 README / docs
  6. 提交 Pull Request — 填写 PR 模板

研发流程

  • 所有修改必须经过 Pull Request
  • PR 必须通过 CI 才能合并
  • PR 需至少 1 位 maintainer approve
  • 使用 squash merge 保持历史清爽

Commit 规范

遵循 Conventional Commits：

feat: add user presence API
fix: resolve message ordering race condition
docs: update README install steps
chore: bump dependency versions

PR 描述

  • 说明改了什么、为什么改
  • 关联 Issue（如 Fixes #123）
  • UI 变化请附截图
  • PR 描述请用英文 — 方便全球社区阅读历史

代码风格

  • Go: gofmt + golangci-lint
  • TypeScript/JavaScript: Prettier + ESLint（配置在仓库内）
  • Swift: SwiftFormat
  • Kotlin: ktlint / Android Studio 默认配置

报告 Bug

使用 GitHub Issue 的 Bug Report 模板。请包含：

  • 期望行为 vs 实际行为
  • 复现步骤
  • 运行环境（操作系统、版本等）
  • 日志 / 截图（如有）

功能建议

使用 GitHub Issue 的 Feature Request 模板。说明使用场景以及现有功能为何不够用。

License

提交贡献即表示你同意将贡献在本项目的 Apache License 2.0 下发布。

有问题？

感谢你一起让 OCTO 变得更好！🚀