7.2 KiB

Raw Blame History Unescape Escape

OpenIM Server документ

Ласкаво просимо до Центру документації OpenIM! Цей центр надає вичерпні посібники та посібники, розроблені, щоб допомогти вам отримати максимальну віддачу від роботи з OpenIM.

Зміст

Contrib - Посібник із внесків і налаштування для розробників
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 - Посібник із використання інструменту protoc.
Go Tools - Інструменти та бібліотеки для Go в OpenIM.
Makefile Tools - Найкращі практики та інструменти для Makefiles.
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 i Error Codes, щоб бути в курсі подій.

Для користувачів

Користувачам слід звернути особливу увагу на:

Docker Installation - Це буде необхідно, якщо ви плануєте використовувати образ Docker OpenIM.
Docker Image Strategy - Дізнайтеся про доступні зображення та про те, як вибрати правильний для вашої архітектури.

7.2 KiB Raw Blame History Unescape Escape