open-im-server/docs/README_zh_CN.md

OpenIM Server 文档

欢迎来到 OpenIM 文档中心！本中心提供全面的指南和手册，旨在帮助您最大限度地利用 OpenIM 体验。

目录

1. Contrib - 为开发者提供的贡献指南和配置
2. Conversions - 编码规范、日志策略和其他转换工具

---

贡献指南

本节为开发人员提供了如何贡献代码、设置环境以及遵循相关流程的详细指南。

• Code Conventions - OpenIM 中编写代码的规则和惯例。
• Development Guide - 关于如何在 OpenIM 内进行开发的指南。
• Git Cherry Pick - 精挑细选的操作指南。
• Git Workflow - OpenIM 中的 git 工作流程。
• Initialization Configurations - 设置和初始化 OpenIM 的指南。
• Docker Installation - 如何在您的机器上安装 Docker。
• Linux Development Environment - 在 Linux 上设置开发环境的指南。
• Local Actions - 关于如何在本地执行某些常见操作的指南。
• Offline Deployment - 离线部署 OpenIM 的方法。
• Protoc Tools - 使用 protoc 工具的指南。
• Go Tools - OpenIM 中 Go 的工具和库。
• Makefile Tools - Makefile 的最佳实践和工具。
• Script Tools - 脚本的最佳实践和工具。

贡献方法

本节介绍 OpenIM 内的各种惯例和政策，包括代码、日志、版本等。

• API Conversions - API 转换的指南和方法。
• Logging Policy - OpenIM 中的日志策略和惯例。
• CI/CD Actions - CI/CD 的程序和惯例。
• Commit Conventions - OpenIM 中代码提交的惯例。
• Directory Conventions - OpenIM 内的目录结构和惯例。
• Error Codes - 错误代码的列表和描述。
• Go Code Conversions - Go 代码的惯例和转换。
• Docker Image Strategy - OpenIM Docker 镜像的管理策略，涵盖多个架构和镜像仓库。
• Logging Conventions - 有关日志的更详细的惯例。
• Version Conventions - OpenIM 版本的命名和管理策略。

对于开发者、贡献者和社区维护者

开发者和贡献者

如果您是一名开发者或热衷于贡献：

• 熟悉我们的 Code Conventions 和 Git Workflow，以确保顺利贡献。
• 深入了解 Development Guide，掌握 OpenIM 的开发实践。

社区维护者

作为社区维护者：

• 确保贡献符合我们文档中概述的标准。
• 定期查看 Logging Policy 和 Error Codes，以保持最新状态。

对于用户

用户应特别注意：

• Docker Installation - 如果您计划使用 OpenIM 的 Docker 镜像，那么这个将会是必须的。
• Docker Image Strategy - 了解可用的镜像以及如何为您的架构选择正确的镜像。