6.0 KiB

Raw Blame History

OpenIM Server Docs

Üdvözöljük az OpenIM dokumentációs központjában! Ez a központ útmutatók és kézikönyvek átfogó választékát kínálja, amelyek célja, hogy a legtöbbet hozza ki az OpenIM-élményből.

Tartalomjegyzék

Contrib - Útmutató a fejlesztőknek a hozzájáruláshoz és a konfigurációkhoz
Conversions - Kódolási konvenciók, naplózási szabályzatok és egyéb átalakítási eszközök

Contrib

Ez a rész részletes útmutatót nyújt a fejlesztőknek a kód hozzáadásával, a környezet beállításával és a kapcsolódó folyamatok követésével kapcsolatban.

Code Conventions - Az OpenIM kódírásának szabályai és konvenciói.
Development Guide - Útmutató az OpenIM-en belüli fejlesztés végrehajtásához.
Git Cherry Pick - Útmutató a cseresznyeszedési műveletekhez.
Git Workflow - A git munkafolyamat az OpenIM-ben.
Initialization Configurations - Útmutató az OpenIM beállításához és inicializálásához.
Docker Installation - A Docker telepítése a gépére.
Linux Development Environment - Guide to set up the development environment on Linux.
Local Actions - Útmutató a fejlesztői környezet beállításához Linuxon.
Offline Deployment - Az OpenIM offline üzembe helyezésének módszerei.
Protoc Tools - Útmutató a protokolleszközök használatához.
Go Tools - Eszközök és könyvtárak az OpenIM for Go-ban.
Makefile Tools - A Makefile legjobb gyakorlatai és eszközei.
Script Tools - Bevált módszerek és eszközök a szkriptekhez.

Conversions

Ez a rész az OpenIM különféle konvencióit és szabályzatait mutatja be, beleértve a kódot, a naplókat, a verziókat és egyebeket.

API Conversions - Irányelvek és módszerek az API-konverziókhoz.
Logging Policy - Naplózási szabályzatok és konvenciók az OpenIM-ben.
CI/CD Actions - CI/CD eljárások és konvenciók.
Commit Conventions - A kód véglegesítésének konvenciói az OpenIM-ben.
Directory Conventions - Címtárszerkezet és konvenciók az OpenIM-en belül.
Error Codes - A hibakódok listája és leírása.
Go Code Conversions - Konvenciók és átalakítások a Go kódhoz.
Docker Image Strategy - Kezelési stratégiák az OpenIM Docker-képekhez, amelyek több architektúrára és képtárra is kiterjednek.
Logging Conventions - További részletes egyezmények a fakitermelésről.
Version Conventions - Elnevezési és kezelési stratégiák az OpenIM verziókhoz.

Fejlesztőknek, közreműködőknek és közösségi fenntartóknak

Fejlesztők és közreműködők

Ha Ön fejlesztő vagy valaki, aki szeretne hozzájárulni:

A zökkenőmentes hozzájárulás érdekében ismerkedjen meg Code Conventions és Git Workflow-val.
Merüljön el a Development Guide, hogy megismerje az OpenIM fejlesztési gyakorlatát.

Közösségfenntartók

Közösségfenntartóként:

Győződjön meg arról, hogy a hozzájárulások megfelelnek a dokumentációnkban felvázolt szabványoknak.
Rendszeresen tekintse át a Logging Policy és a Error Codes, hogy naprakész maradjon.

Felhasználóknak

A felhasználóknak különös figyelmet kell fordítaniuk a következőkre:

Docker Installation - Szükséges, ha az OpenIM Docker-képeit szeretné használni.
Docker Image Strategy - Hogy megértse a rendelkezésre álló különböző képeket, és hogyan válassza ki a megfelelőt az építészetéhez.

6.0 KiB Raw Blame History