mirror of
https://github.com/openimsdk/open-im-server.git
synced 2025-04-05 05:12:45 +08:00
Contrib Documentation Index
📚 General Information
- 📄 README - General introduction to the contribution documentation.
- 📑 Development Guide - Guidelines for setting up a development environment.
🛠 Setup and Installation
- 🌍 Environment Setup - Instructions on setting up the development environment.
- 🐳 Docker Installation Guide - Steps to install Docker for container management.
- 🔧 OpenIM Linux System Installation - Guide for installing OpenIM on a Linux system.
💻 Development Practices
- 👨💻 Code Conventions - Coding standards to follow for consistency.
- 📐 Directory Structure - Explanation of the repository's directory layout.
- 🔀 Git Workflow - The workflow for using Git in this project (note the file extension error).
- 💾 GitHub Workflow - Workflow guidelines for GitHub.
🧪 Testing and Deployment
- ⚙️ CI/CD Actions - Continuous integration and deployment configurations.
- 🚀 Offline Deployment - How to deploy the application offline.
🔧 Utilities and Tools
- 📦 Protoc Tools - Protobuf compiler-related utilities.
- 🔨 Utility Go - Go utilities and helper functions.
- 🛠 Makefile Utilities - Makefile scripts for automation.
- 📜 Script Utilities - Utility scripts for development.
📋 Standards and Conventions
- 🚦 Commit Guidelines - Standards for writing commit messages.
- ✅ Testing Guide - Guidelines and conventions for writing tests.
- 📈 Versioning - Version management for the project.
🖼 Additional Resources
- 🌐 API Reference - Detailed API documentation.
- 📚 Go Code Standards - Go programming language standards.
- 🖼 Image Guidelines - Guidelines for image assets.
🐛 Troubleshooting
- 🔍 Error Code Reference - List of error codes and their meanings.
- 🐚 Bash Logging - Logging standards for bash scripts.
- 📈 Logging Conventions - Conventions for application logging.
- 🛠 Local Actions Guide - How to perform local actions for troubleshooting.