You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
5.7 KiB
5.7 KiB
OpenIM Server Docs
Tervetuloa OpenIM-dokumentaatiokeskukseen! Tämä keskus tarjoaa kattavan valikoiman oppaita ja oppaita, jotka on suunniteltu auttamaan sinua saamaan kaiken irti OpenIM-kokemuksestasi.
Sisällysluettelo
- Contrib - Ohjeita kehittäjille osallistumiseen ja määrityksiin
- Conversions - Koodauskäytännöt, lokikäytännöt ja muut muunnostyökalut
Contrib
Tämä osio tarjoaa kehittäjille yksityiskohtaisen oppaan koodin lisäämisestä, ympäristön määrittämisestä ja siihen liittyvien prosessien seuraamisesta.
- Code Conventions - Säännöt ja käytännöt koodin kirjoittamiselle OpenIM:ssä.
- Development Guide - Opas kehitystyön toteuttamiseen OpenIM:ssä.
- Git Cherry Pick - Kirsikoiden poimimista koskevat ohjeet.
- Git Workflow - Git-työnkulku OpenIM:ssä.
- Initialization Configurations - Ohjeita OpenIM:n käyttöönottoon ja alustamiseen.
- Docker Installation - Kuinka asentaa Docker koneellesi.
- Linux Development Environment - Ohje kehitysympäristön määrittämiseen Linuxissa.
- Local Actions - Ohjeita tiettyjen yhteisten toimien toteuttamiseen paikallisesti.
- Offline Deployment - OpenIM:n offline-käyttöönottomenetelmät.
- Protoc Tools - Opas protokollatyökalujen käyttöön.
- Go Tools - OpenIM for Go -työkalut ja kirjastot.
- Makefile Tools - Makefilen parhaat käytännöt ja työkalut.
- Script Tools - Skriptien parhaat käytännöt ja työkalut.
Tulokset
Tässä osiossa esitellään erilaisia OpenIM:n käytäntöjä ja käytäntöjä, jotka kattavat koodin, lokit, versiot ja paljon muuta.
- API Conversions - Ohjeita ja menetelmiä API-muunnoksille.
- Logging Policy - Kirjauskäytännöt ja käytännöt OpenIM:ssä.
- CI/CD Actions - CI/CD:n menettelyt ja käytännöt.
- Commit Conventions - OpenIM:n koodisitoumusten käytännöt.
- Directory Conventions - Hakemistorakenne ja käytännöt OpenIM:ssä.
- Error Codes - Luettelo ja kuvaukset virhekoodeista.
- Go Code Conversions - Go-koodin sopimukset ja muunnokset.
- Docker Image Strategy - Hallintastrategiat OpenIM Docker -kuville, jotka kattavat useita arkkitehtuureja ja kuvavarastoja.
- Logging Conventions - Tarkemmat hakkuiden käytännöt.
- Version Conventions - Nimeämis- ja hallintastrategiat OpenIM-versioille.
Kehittäjille, avustajille ja yhteisön ylläpitäjille
Kehittäjät ja avustajat
Jos olet kehittäjä tai joku, joka haluaa osallistua:
- Tutustu Code Conventions- ja Git Workflow -käytäntöihimme varmistaaksesi sujuvan osallistumisen.
- Sukella Development Guide saadaksesi tietoa OpenIM:n kehityskäytännöistä.
Yhteisön ylläpitäjät
Yhteisön ylläpitäjänä:
- Varmista, että osallistumiset ovat asiakirjoissamme esitettyjen standardien mukaisia.
- Tarkista säännöllisesti Logging Policy ja Error Codes pysyäksesi ajan tasalla.
Käyttäjille
Käyttäjien tulee kiinnittää erityistä huomiota:
- Docker Installation - Välttämätön, jos aiot käyttää OpenIM:n Docker-kuvia.
- Docker Image Strategy - Ymmärtääksesi saatavilla olevat erilaiset kuvat ja kuinka valita oikea arkkitehtuuriisi.