|
|
|
|
|
# OpenIMサーバードキュメンテーション
|
|
|
|
|
|
|
|
|
|
|
|
OpenIMドキュメンテーションハブへようこそ！このセンターでは、OpenIM体験を最大限に活用するための包括的なガイドとマニュアルを提供しています。
|
|
|
|
|
|
|
|
|
|
|
|
## 目次
|
|
|
|
|
|
|
|
|
|
|
|
1. [Contrib](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib) - 開発者向けの貢献と設定に関するガイダンス
|
|
|
|
|
|
2. [Conversions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib) - コーディング規約、ログポリシー、その他の変換ツール
|
|
|
|
|
|
|
|
|
|
|
|
------
|
|
|
|
|
|
|
|
|
|
|
|
## 投稿
|
|
|
|
|
|
|
|
|
|
|
|
このセクションでは、開発者がコードを貢献し、環境を設定し、関連するプロセスに従う方法についての詳細なガイドを提供します。
|
|
|
|
|
|
|
|
|
|
|
|
- [Code Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/code-conventions.md) - OpenIMでのコード記述のルールと規約。
|
|
|
|
|
|
- [Development Guide](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/development.md) - OpenIM内での開発を行うためのガイド。
|
|
|
|
|
|
- [Git Cherry Pick](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/gitcherry-pick.md) - チェリーピッキング操作のガイドライン。
|
|
|
|
|
|
- [Git Workflow](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/git-workflow.md) - OpenIMにおけるGitのワークフロー。
|
|
|
|
|
|
- [Initialization Configurations](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/init-config.md) - OpenIMの設定と初期化に関するガイダンス。
|
|
|
|
|
|
- [Docker Installation](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/install-docker.md) - マシンにDockerをインストールする方法。
|
|
|
|
|
|
- [Linux Development Environment](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/linux-development.md) - Linux上での開発環境の設定ガイド。
|
|
|
|
|
|
- [Local Actions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/local-actions.md) - ローカルで一般的なアクションを実行する方法に関するガイドライン。
|
|
|
|
|
|
- [Offline Deployment](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/offline-deployment.md) - OpenIMをオフラインでデプロイする方法。
|
|
|
|
|
|
- [Protoc Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/protoc-tools.md) - protocツールの使用ガイド。
|
|
|
|
|
|
- [Go Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util-go.md) - GoのためのOpenIM内のツールとライブラリ。
|
|
|
|
|
|
- [Makefile Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util-makefile.md) - Makefileのベストプラクティスとツール。
|
|
|
|
|
|
- [Script Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util-scripts.md) - スクリプトのベストプラクティスとツール。
|
|
|
|
|
|
|
|
|
|
|
|
## Conversions
|
|
|
|
|
|
|
|
|
|
|
|
このセクションでは、OpenIM内のさまざまな規約とポリシーを紹介します。これには、コード、ログ、バージョンなどが含まれます。
|
|
|
|
|
|
|
|
|
|
|
|
- [API Conversions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/api.md) - API変換のためのガイドラインと方法。
|
|
|
|
|
|
- [Logging Policy](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/bash-log.md) - OpenIMにおけるログポリシーと規約。
|
|
|
|
|
|
- [CI/CD Actions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/cicd-actions.md) - CI/CDの手順と規約。
|
|
|
|
|
|
- [Commit Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/commit.md) - OpenIMでのコードコミットのための規約。
|
|
|
|
|
|
- [Directory Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/directory.md) - OpenIM内のディレクトリ構造と規約。
|
|
|
|
|
|
- [Error Codes](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/error-code.md) - エラーコードのリストと説明。
|
|
|
|
|
|
- [Go Code Conversions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/go-code.md) - Goコードのための規約と変換。
|
|
|
|
|
|
- [Docker Image Strategy](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md) - 複数のアーキテクチャとイメージリポジトリにまたがるOpenIM Dockerイメージの管理戦略。
|
|
|
|
|
|
- [Logging Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/logging.md) - ロギングに関するさらに詳細な規約。
|
|
|
|
|
|
- [Version Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md) - OpenIMバージョンの命名と管理戦略。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## 開発者、コントリビューター、コミュニティメンテナー向け
|
|
|
|
|
|
|
|
|
|
|
|
### 開発者およびコントリビューター
|
|
|
|
|
|
|
|
|
|
|
|
開発者または貢献に熱心な方へ：
|
|
|
|
|
|
|
|
|
|
|
|
- スムーズな貢献を確実にするために、私たちの[Code Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/code-conventions.md)と[Git Workflow](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/git-workflow.md)に慣れ親しみましょう。
|
|
|
|
|
|
- OpenIMの開発実践に慣れるために、[Development Guide](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/development.md)をご覧ください。
|
|
|
|
|
|
|
|
|
|
|
|
### コミュニティメンテナー
|
|
|
|
|
|
|
|
|
|
|
|
コミュニティメンテナーとして：
|
|
|
|
|
|
|
|
|
|
|
|
- 貢献が私たちのドキュメンテーションで概説された基準に沿っていることを確認してください。
|
|
|
|
|
|
- 最新の情報を得るために、定期的に[Logging Policy](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/bash-log.md)と[Error Codes](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/error-code.md)をレビューしてください。
|
|
|
|
|
|
|
|
|
|
|
|
## ユーザー向け
|
|
|
|
|
|
|
|
|
|
|
|
ユーザーは特に以下の点に注意してください：
|
|
|
|
|
|
|
|
|
|
|
|
- [Docker Installation](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/install-docker.md) - OpenIMのDockerイメージを使用する予定の場合に必要です。
|
|
|
|
|
|
- [Docker Image Strategy](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md) - 利用可能なさまざまなイメージを理解し、アーキテクチャに適したものを選択する方法。
|
