open-im-server/docs/README_ru.md

Документация по серверу OpenIM

Добро пожаловать в центр документации OpenIM! Этот центр предоставляет широкий спектр руководств и руководств, призванных помочь вам максимально эффективно использовать возможности OpenIM.

Оглавление

1. Contrib - Руководство по участию и настройке для разработчиков
2. Conversions - Соглашения по кодированию, политики ведения журналов и другие инструменты преобразования.

---

Вклад

В этом разделе разработчикам предлагается подробное руководство о том, как добавлять код, настраивать среду и следовать соответствующим процессам.

• Code Conventions - Правила и соглашения по написанию кода в OpenIM.
• Development Guide - Руководство о том, как вести разработку в OpenIM.
• Git Cherry Pick - Руководство по сбору урожая.
• Git Workflow - Рабочий процесс git в OpenIM.
• Initialization Configurations - Руководство по настройке и инициализации OpenIM.
• Docker Installation - Как установить Docker на свой компьютер.
• Linux Development Environment - Руководство по настройке среды разработки в Linux.
• Local Actions - Рекомендации о том, как выполнять определенные общие действия на местном уровне.
• Offline Deployment - Способы развертывания OpenIM в автономном режиме.
• Protoc Tools - Руководство по использованию инструментов протокола.
• 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 - Необходимо, если вы планируете использовать Docker-образы OpenIM.
• Docker Image Strategy - Чтобы понять различные доступные изображения и как выбрать подходящее для вашей архитектуры.