open-im-server/docs/README_ko.md

OpenIM 서버 문서

OpenIM 문서 허브에 오신 것을 환영합니다! 이 센터는 OpenIM 경험을 최대한 활용하는 데 도움이 되도록 다양한 가이드와 매뉴얼을 제공합니다.

목차

1. Contrib - 개발자를 위한 기여 및 구성에 대한 안내
2. Conversions - 코딩 규칙, 로깅 정책 및 기타 변환 도구

---

기여

이 섹션은 개발자들에게 코드를 기여하는 방법, 환경을 설정하는 방법 및 관련 프로세스를 따르는 방법에 대한 자세한 가이드를 제공합니다.

• Code Conventions - OpenIM에서 코드를 작성하기 위한 규칙 및 규약.
• Development Guide - OpenIM 내에서 개발을 수행하는 방법에 대한 가이드.
• Git Cherry Pick - 체리피킹 작업에 대한 지침.
• Git Workflow - OpenIM에서의 깃 워크플로우.
• Initialization Configurations - OpenIM 설정 및 초기화에 대한 안내.
• Docker Installation - 컴퓨터에 도커를 설치하는 방법.
• Linux Development Environment - 리눅스에서 개발 환경을 설정하는 가이드.
• Local Actions - 일부 일반적인 작업을 로컬에서 수행하는 방법에 대한 지침.
• Offline Deployment - 오프라인에서 OpenIM을 배포하는 방법.
• Protoc Tools - 프로토콜 도구 사용에 대한 가이드.
• Go Tools - Go용 OpenIM 도구 및 라이브러리.
• Makefile Tools - 메이크파일을 위한 모범 사례 및 도구.
• 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에 익숙해지십시오.
• OpenIM에서의 개발 관행을 파악하려면 Development Guide를 참조하십시오.

커뮤니티 관리자

커뮤니티 관리자로서:

• 기여가 우리 문서에 명시된 표준에 부합하는지 확인하십시오.
• Logging Policy 및 Error Codes를 정기적으로 검토하여 최신 정보를 유지하십시오.

사용자를 위한 정보

사용자는 특히 다음 사항에 주의를 기울여야 합니다:

• Docker Installation - OpenIM의 Docker 이미지를 사용할 계획이라면 필요합니다.
• Docker Image Strategy - 사용 가능한 다양한 이미지를 이해하고 아키텍처에 적합한 이미지를 선택하는 방법.